Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.46 KB

RELEASING.md

File metadata and controls

41 lines (29 loc) · 1.46 KB

Release Process

To publish a new version of these crates:

  1. Bump the crate versions using semantic versioning. As described in Cargo's semver compatibility documentation and because this crate is not yet released as "1.0", we typically release major breaking changes as a minor semver bump and anything less than that as a patch semver bump. After bumping, open a PR:

    git checkout -b bump-version
    cargo xtask bump patch --git
    git push -u <FORK>
    # open PR
  1. Once the bump PR is merged, publish the crates:

    git checkout main
    git pull
    cargo xtask publish --git

    You may want to check that everything looks right on crates.io after this step. Note that the --git flag is equivalent to git tag v<VERSION>; git push origin v<VERSION>. If your remotes won't work with this default origin for any reason, those commands can be run manually.

  1. Once published, draft a new release on GitHub. Use the newly-published tag and use "Generate release notes" for a sane changelog description.
  1. Eventually, check that docs.rs was able to build the crate documentation correctly.