Skip to content

Commit

Permalink
Update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdrz committed Nov 1, 2023
1 parent 7ed33dd commit d1cc3c2
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -544,15 +544,6 @@ like the following is a useful way to check what has landed:

Also worth checking the [next-release tag](https://github.com/rust-lang/rust-bindgen/pulls?q=is%3Apr+label%3Anext-release).

Once that's done and the changelog is up-to-date, run `doctoc` on it.

If needed, install it locally by running:

```
$ npm install doctoc
$ ./node_modules/doctoc/doctoc.js CHANGELOG.md
```

### Merge to `main`

For regular releases, the changes above should end up in `main` before
Expand All @@ -561,14 +552,21 @@ important fix) you can skip this.

### Tag and publish

Once you're in the right branch, do:
Once you're in `main`. Remember to install `doctoc` by running:
```
npm install doctoc
```

And then run:
```
cargo release [patch|minor] --no-publish --execute
```

This does the following:

- Bump the version.
- Turn the `Unreleased` section of the changelog into the section for the version being published.
- Update the table of contents of the changelog using `doctoc`.
- Tag (`git tag`) the HEAD commit
- Publish (`cargo publish`) bindgen and bindgen-cli
- Push (`git push`) to GitHub
Expand Down

0 comments on commit d1cc3c2

Please sign in to comment.