Skip to content

Commit

Permalink
Clarify release process (#94)
Browse files Browse the repository at this point in the history
Minor clarifications to `RELEASING.md`.
  • Loading branch information
richvdh authored Jan 24, 2024
1 parent 45e8ea3 commit 5f9854b
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,29 @@ we can update the version by following these steps:

1. Ensure `.cargo/config` does **not** contain the `patch` section for local
development recommended in `README.md`.
2. Run `cargo update`
2. Run `cargo update`.

## Doing the release

We try to use semantic versioning, so the version number is
`v<major>.<minor>.<patch>`. Most releases will be a minor version. If there are
significant breaking changes, bump the major version number. If you're only
making minor fixes to the bindings themselves, a patch version may be
appropriate.

**Note**: the `cargo update` process above will often bring in significant
changes to a number of dependencies. These are _not_ normally appropriate in a
patch version.

1. Create a new branch, named `release-v<version>`.
2. Update `CHANGELOG.md` and `git add` ready for commit on the next step.
3. Run `yarn version` to bump the version number, commit, and create a tag.
2. Replace the "UNRELEASED" heading in `CHANGELOG.md` with the new version
number, start a new (empty) "UNRELEASED" section, and `git add` ready for
commit on the next step.
3. Run `yarn version`. It will ask you the version number, then update
`package.json`, commit, and create a tag.
4. Push the branch, but not yet the tag.
5. Create a PR to approve the changes.
5. Create a PR to approve the changes. Reviewers should mostly check that the
changelog is coherent.
6. Once approved:
1. Update the git tag to the new head of the branch, if necessary.
2. Push the git tag (`git push origin tag v<version>`). Doing so triggers
Expand Down

0 comments on commit 5f9854b

Please sign in to comment.