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 c73990c commit 6666724
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,11 @@ like the following is a useful way to check what has landed:
$ git log --oneline v0.62.0..HEAD
```

Also worth checking the [next-release tag](https://github.com/rust-lang/rust-bindgen/pulls?q=is%3Apr+label%3Anext-release).
Also worth checking the [next-release
tag](https://github.com/rust-lang/rust-bindgen/pulls?q=is%3Apr+label%3Anext-release).
It is very important that you do not rename the `Unreleased` section of the
changelog as this will be done automatically using `cargo release` on a further
step.

### Merge to `main`

Expand Down Expand Up @@ -601,4 +605,20 @@ cargo dist init # from "cargo install cargo-dist"
cargo dist generate-ci # to update .github/workflows/release.yml
```

### What to do if a Github release fails

If the release process failed after you run `cargo release` you can manually
delete the tag and release from Github. Also remember to delete the tag locally
by running `git tag -d`. Once all the extra changes are in the `main` branch
you can trigger a release by creating a new tag using `git tag` and push it
using `git push --tag`.

### Create a new crates.io release

Go to [the Publish
workflow](https://github.com/rust-lang/rust-bindgen/actions/workflows/publish.yml)
and run a new workflow using the "Run Workflow" button.

Remember that crates.io releases cannot be deleted!

[prettyplease]: https://github.com/dtolnay/prettyplease

0 comments on commit 6666724

Please sign in to comment.