RELEASING.md

Releasing

This document will cover how to properly release Vector.

Vector adheres to Semantic Versioning and the release process is dependent on the version change.

1. Quick Start
   1. Patch Releases
   2. Major/Minor Releases

Quick Start

Patch Releases

1. Create a new branch from the latest vMAJOR.MINOR.PATCH tag. Ex: git checkout -b v1.2.3 v1.2.2
2. Make the appropriate changes/fixes.
3. Update the version key in /Cargo.toml and run cargo build to get the version bump in the Cargo.lock file.
4. Update the /CHANGELOG.md header to reflect the new version vMAJOR.MINOR.PATCH - 2019-05-02
5. Commit the changes above with message "Release vMAJOR.MINOR.PATCH"
6. Create a new tag named vMAJOR.MINOR.PATCH
7. Push the new tag
8. Delete the temporary branch you created.
9. All done

Major/Minor Releases

1. Switch to the master branch, this should be reflective of the new version's changes.
2. Update the version key in /Cargo.toml and run cargo build to get the version bump in the Cargo.lock file.
3. Update the /CHANGELOG.md header to reflect the new version vMAJOR.MINOR.0 - 2019-05-02
4. Commit the changes above with message "Release vMAJOR.MINOR.PATCH"
5. Create a new tag named vMAJOR.MINOR.PATCH
6. Push the new tag.
7. Update the /CHANGELOG.md header to reflect the new upcoming version vNEW_MAJOR.NEW_MINOR-dev
8. Commit the changes above with message "Start vNEW_MAJOR.NEW_MINOR+1"
9. All done