Skip to content

Commit 6666724

Browse files
committed
Update release instructions
1 parent c73990c commit 6666724

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,11 @@ like the following is a useful way to check what has landed:
542542
$ git log --oneline v0.62.0..HEAD
543543
```
544544

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

547551
### Merge to `main`
548552

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

608+
### What to do if a Github release fails
609+
610+
If the release process failed after you run `cargo release` you can manually
611+
delete the tag and release from Github. Also remember to delete the tag locally
612+
by running `git tag -d`. Once all the extra changes are in the `main` branch
613+
you can trigger a release by creating a new tag using `git tag` and push it
614+
using `git push --tag`.
615+
616+
### Create a new crates.io release
617+
618+
Go to [the Publish
619+
workflow](https://github.com/rust-lang/rust-bindgen/actions/workflows/publish.yml)
620+
and run a new workflow using the "Run Workflow" button.
621+
622+
Remember that crates.io releases cannot be deleted!
623+
604624
[prettyplease]: https://github.com/dtolnay/prettyplease

0 commit comments

Comments
 (0)