Skip to content

Commit

Permalink
doc(crate): improved doc for version update process
Browse files Browse the repository at this point in the history
  • Loading branch information
Wicpar committed Sep 24, 2023
1 parent afa90ad commit 553702d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,16 @@ and no one is already working on the same thing.

If you are unsure, feel free to open an [issue](https://github.com/tamasfe/aide/issues) or start a [discussion](https://github.com/tamasfe/aide/discussions)!

# Changelogs
# Updating a version (for collaborators)

Changelogs are generated as follows using [git-cliff](https://git-cliff.org/docs/) (`cargo install git-cliff`), replace <crate> by the crate name (ie. aide) and <version by the next version>.
1. Create a version bump commit
2. Create a tag `git tag release-<crate>-<version>`
3. Generate the changelog with `cargo install git-cliff`:
Make sure you delete the old `# Changelog` title in the changelog file.

```sh
git cliff --config "crates/<crate>/cliff.toml" --include-path "crates/<crate>/**/*" --unreleased --tag <version> --prepend crates/<crate>/CHANGELOG.md
git cliff --config "crates/<crate>/cliff.toml" --include-path "crates/<crate>/**/*" --current --prepend crates/<crate>/CHANGELOG.md
```
4. push the commits and the tag: `git push` and `git push origin release-<crate>-<version>`

# License

Expand Down

0 comments on commit 553702d

Please sign in to comment.