GitoxideLabs/gitoxide cargo-smart-release-v0.4.0

cargo-smart-release v0.4.0

on GitHub

This major release adds changelog support to automatically generate scaffolding to be filled in by hand. The feature is driven by
conventional commit messages which are used sparingly to mark important changes only.
Furthermore, it will deduce the require version bump, i.e. patch, minor or major, automatically by looking at the commit history
and interpreting 'conventional commit' messages. This means that from time to time one would sprinkle in a specifically formatted
commit message to leave enough information to determine the correct release version and create changelog scaffolding.

If you have 10 minutes, the following video gives the whirlwind tour through the new features (and note that all issues discovered there
have been fixed :)).

If you have 30 minutes, there is also a long version of the video.

And there is another one showing cargo smart-release releasing gitoxide 0.9.0, along with some explanation on how it works.

Changelog Support in cargo smart-release

When using cargo smart-release in dry-run mode (default), additional information regarding changelog will be printed.
This informs you a release would be attempted, or if manual adjustments to the changelogs would be required, for example as
they are fully generated with statistical information only.

If there is no issue with the initial changelogs, passing the --execute flag will write the changelogs after
providing them to you for preview (using bat) for a last chance to abort the operation. Otherwise the publishing
will proceed, which includes the creation of tag objects containing the relevant section of the changelog, along with
a GitHub release which is annotated with the same section (only if the repository is hosted on GitHub).

If there are issues to be corrected, there will be suggestions to run cargo changelog --write --only <crate-name>
one by one, or the release operation will have left a single commit with all changelogs written out.
In any case, it's recommended to re-write the changelog after editing to assure it is indeed stable and won't change each time
the generator is run.

For more information, run cargo smart-release -h.

The cargo changelog Sub-Command

This new sub-command sports the same dependency resolution as smart-release itself, operates in dry-run mode by default
to preview changelogs that would be written. Use the --write flag to actually write changes to disk.

It's primary use is to conveniently generate changelogs from time to time to add the final polish by hand before
actually releasing them along with the crate with smart-release.

For more information, run cargo changelog -h.

Other BREAKING Changes

• renamed --skip-* flags to --no-* for consistency
• rename --skip-dependencies to --no-dependencies to be more inline with existing terminology of other flags.
• rename short name for --execute to -e from -n for consistency

Other Changes

• --no-dependencies now has --only as alias

Bug Fixes

• Previously it might have been possible to see that it won't use a 'new' crate version as it's already in the manifest, even if these are the same. This is now fixed.

Commit Statistics

• 280 commits contributed to the release over the course of 36 calendar days.
• 19 commits where understood as conventional.
• 6 unique issues were worked on: #192, #197, #198, #200, #213, #67

Thanks Clippy

Clippy helped 27 times to make code idiomatic.

Commit Details