fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-07-31 17:01:58 +00:00
Code Issues Projects Releases Wiki Activity

docs(release): Skip unused cargo release steps

Browse Source 
`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.
This commit is contained in:
Max Inden
2023-03-14 20:22:21 +01:00
committed by GitHub
parent d7bf56376e
commit 1b09b8c85c
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/release.md
View File

@@ -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