Skip to content

Commit d1cc3c2

Browse files
committed
Update release instructions
1 parent 7ed33dd commit d1cc3c2

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -544,15 +544,6 @@ like the following is a useful way to check what has landed:
544544

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

547-
Once that's done and the changelog is up-to-date, run `doctoc` on it.
548-
549-
If needed, install it locally by running:
550-
551-
```
552-
$ npm install doctoc
553-
$ ./node_modules/doctoc/doctoc.js CHANGELOG.md
554-
```
555-
556547
### Merge to `main`
557548

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

562553
### Tag and publish
563554

564-
Once you're in the right branch, do:
555+
Once you're in `main`. Remember to install `doctoc` by running:
556+
```
557+
npm install doctoc
558+
```
565559

560+
And then run:
566561
```
567562
cargo release [patch|minor] --no-publish --execute
568563
```
569564

570565
This does the following:
571566

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

0 commit comments

Comments
 (0)