Skip to content

Commit

Permalink
📬 changelog: add publish instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
katelyn martin committed Sep 8, 2021
1 parent cbfb85b commit ad6489a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Below are the steps needed to do a Viceroy release:
1. Update the Changelog so that it contains all of the updates since the previous version as it's own commit
1. Push a branch in the form `release-x.y.z` where `x`, `y`, and `z` are the major, minor, and patch versions of Viceroy and have the tip of the branch contain the Changelog commit.
1. Run `make ci` locally to make sure that everything will pass before pushing the branch and opening up a PR
1. Publish each crate in the workspace. Note that we must do this in order of dependencies. So,
1. `cd lib && cargo publish`
1. `cd cli && cargo publish`
1. When you get approval run `git tag vx.y.z HEAD && git push origin --tags` on the branch where `x`, `y`, and `z` again correspond to the Viceroy version to kick off the build for all of the artifacts.
1. When that is good and completes, push a commit to the branch that bumps Viceroy to the next patch version (so `z + 1`) and updates all the lockfiles again
1. Get approval again and merge when CI passes

0 comments on commit ad6489a

Please sign in to comment.