Skip to content

RELEASING.md

Latest commit

 

History

History
63 lines (41 loc) · 2.32 KB

RELEASING.md

File metadata and controls

63 lines (41 loc) · 2.32 KB

Release Checklist

These steps assume that you've checked out the scale-info repository and are in the root directory of it.

We also assume that ongoing work done is being merged directly to the master branch.

  1. Ensure that everything you'd like to see released is on the master branch.

  2. Create a release branch off master, for example release-v0.17.0. Decide how far the version needs to be bumped based on the changes to date.

  3. Check that you're happy with the current documentation.

    cargo doc --open

    If there are minor issues with the documentation, they can be fixed in the release branch.

  4. Bump the crate versions in ./Cargo.toml and ./derive/Cargo.toml to whatever was decided in step 2 (basically a find and replace from old version to new version in this file should do the trick).

  5. Update CHANGELOG.md to reflect the difference between this release and the last. See the CHANGELOG.md file for details of the format it follows.

    First, if there have been any significant changes, add a description of those changes to the top of the changelog entry for this release.

  6. Commit any of the above changes to the release branch and open a PR in GitHub with a base of master.

  7. Once the branch has been reviewed and passes CI, merge it.

  8. Now, we're ready to publish the release to crates.io.

    1. Checkout master, ensuring we're looking at that latest merge (git pull).

      git checkout master && git pull

    2. Perform a final sanity check that everything looks ok.

      cargo test --all-targets

    3. Run the following command to publish both crates.

      (cd derive && cargo publish) && cargo publish

  9. If the release was successful, tag the commit that we released in the master branch with the version that we just released, for example:

    git tag -s v2.7.0 # use the version number you've just published to crates.io, not this one
git push --tags

    Once this is pushed, go along to the releases page on GitHub and draft a new release which points to the tag you just pushed to master above. Copy the changelog comments for the current release into the release description.