Skip to content

Commit

Permalink
docs: RELEASING.md say cargo changelog is from cargo-smart-release (
Browse files Browse the repository at this point in the history
  • Loading branch information
MingweiSamuel authored Aug 22, 2024
1 parent 0ee5d96 commit e8a40eb
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ On the commit immediately _before_ you move the package(s) and run the following
```
cargo changelog --write <crate_to_be_moved> <other_crate_to_be_moved> ...
```
(This command is provided by `cargo install cargo-smart-release`; don't use any other `cargo changelog` command)

Then, before committing the changes, go through the modified `CHANGELOG.md` files and add a prefix
to the `Commit Statistics` and `Commit Details` headers, for example: `Pre-Move Commit Statistics`/`Pre-Move Commit Details`.
This is necessary because otherwise `cargo-smart-release` will treat those sections as auto-generated
Expand Down

0 comments on commit e8a40eb

Please sign in to comment.