Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.89 KB

RELEASE.md

File metadata and controls

41 lines (30 loc) · 1.89 KB
Raw

Making a release

To make a new release of bempp, follow the following steps:

  1. If you are yet to make a release on your current computer, run cargo login and copy an API key from https://crates.io/me

  2. Checkout the main branch and git pull, then checkout a new branch called release-v[x].[y].[z] (where [x], [y], and [z] are defined in the next step):

    git checkout main
git pull
git checkout -b release-v[x].[y].[z]

  3. Update the version numbers in Cargo.toml and pyproject.toml. The version numbers have the format [x].[y].[z]. If you are releasing a major version, you should increment [x] and set [y] and [z] to 0. If you are releasing a minor version, you should increment [y] and set [z] to zero. If you are releasing a bugfix, you should increment [z].

  4. Update the version number in the "Using bempp" section of README.md.

  5. Commit your changes and push to GitHub. Wait to see if the CI tests pass.

  6. Create a release on GitHub from the main branch. The release tag and title should be v[x].[y].[z] (where [x], [y] and [z] are as in step 2). In the "Describe this release" box, you should bullet point the main changes since the last release.

  7. Run cargo publish --dry-run, then run cargo package --list and check that no unwanted extras have been included in the release.

  8. If everything is working as expected, run cargo publish. This will push the new version to crates.io. Note: this cannot be undone, but you can use cargo yank to mark a version as unsuitable for use.

  9. Open a pull request to main to update the version numbers in Cargo.toml and pyproject.toml to [x].[y].[z]-dev

  10. Add the release to the next issue of Scientific Computing in Rust Monthly