From d1cc3c2432ce4e7e8bf7b0462e54d61731f72118 Mon Sep 17 00:00:00 2001 From: Christian Poveda Date: Wed, 1 Nov 2023 12:43:57 -0500 Subject: [PATCH] Update release instructions --- CONTRIBUTING.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58d47a41e9..1fdacaaf6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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