Skip to content

Commit

Permalink
docs(release): Skip unused cargo release steps
Browse files Browse the repository at this point in the history
`cargo release` provides multiple steps:
- changes
- version
- replace
- hook
- commit
- publish
- owner
- tag
- push
- config
- help

We only make use of `publish` and `tag`. We explicitly don't want `cargo release` to do `version` or `commit`.

Update the release docs accordingly, namely replace the generic `cargo release` with a two step process `cargo release publish` and `cargo release tag`.

Pull-Request: #3596.
  • Loading branch information
mxinden authored Mar 14, 2023
1 parent d7bf563 commit 1b09b8c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,11 @@ documentation will refer to `X.Y.Z` as _major_, _minor_ and _patch_ version.
`CHANGELOG.md`. Create a pull request with the changes against the
rust-libp2p `master` branch.

2. Once merged, run `cargo release --workspace --sign-tag --no-push --execute`
on the (squash-) merged commit on the `master` branch.
2. Once merged, run the two commands below on the (squash-) merged commit on the `master` branch.

1. `cargo release publish --execute`

2. `cargo release tag --sign-tag --execute`

3. Confirm that `cargo release` tagged the commit correctly via `git push
$YOUR_ORIGIN --tag --dry-run` and then push the new tags via `git push
Expand Down

0 comments on commit 1b09b8c

Please sign in to comment.