Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎁 prepare release 0.9.5 #350

Merged
merged 4 commits into from
Mar 18, 2024
Merged

🎁 prepare release 0.9.5 #350

merged 4 commits into from
Mar 18, 2024

Conversation

JakeChampion
Copy link
Contributor

Cutting a new release, this currently contains steps 1 through to 5 of Releasing Viceroy.

Below are the steps needed to do a Viceroy release:

  1. Make sure the Viceroy version has been bumped up to the current release
    version. You might need to bump the minor version (e.g. 0.2.0 to 0.3.0) if
    there are any semver breaking changes. Review the changes since the last
    release just to be sure.
  2. Update the Cargo.lock files by running make generate-lockfile.
  3. Update CHANGELOG.md so that it contains all of the updates since the
    previous version as its own commit.
  4. Create a local 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.
  5. Run make ci locally to make sure that everything will pass before pushing
    the branch and opening up a PR.
  6. After you get approval, run git tag vx.y.z HEAD && git push origin --tags.
    Pushing this tag will kick off a build for all of the release artifacts.
  7. After CI completes, we should publish each crate in the workspace to the
    crates.io registry. Note that we must do this in order of dependencies. So,
  8. (cd lib && cargo publish)
  9. (cd cli && cargo publish)
  10. Now, we should return to our release PR.
  11. Update the version fields in lib/Cargo.toml and cli/Cargo.toml to the
    next patch version (so z + 1).
  12. Update the dependency on viceroy-lib in cli/Cargo.toml to the next
    patch version.
  13. Update all the lockfiles by running make generate-lockfile.
  14. Restore the ## Unreleased header at the top of CHANGELOG.md.
  15. Get another approval and merge when CI passes.

@JakeChampion JakeChampion requested a review from acw March 15, 2024 16:38
acw
acw previously approved these changes Mar 15, 2024
Copy link
Contributor

@acw acw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@acw acw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@JakeChampion JakeChampion merged commit 8feaf78 into main Mar 18, 2024
7 checks passed
@JakeChampion JakeChampion deleted the jake/release-0.9.5 branch March 18, 2024 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants