[carg-smart-release] How to remove commit statistics and commit details from the changelog?

[jcornaz]

Hi,

cargo smart-release and it's companion cargo changelog are awesome!

But, I am personally not a big fan of the "commit details" and "commit statistics" section in the generated changelog. In my opinion, they are details that are irrelevant for the reader of the changelog.

I know I can remove one of them. By either adding --without commit-statistics or --without commit-details.

But I can I remove both sections? I tried comma-separated list, and multiple occurences of the --without option, but without success.

[Byron]

Thank you for the praise :)!

Indeed, --without is the flag to use and when I tried like this cargo changelog --without commit-statistics --without commit-details it worked as expected. This also worked for the smart-release command, using the --changelog-without flag respectively.

I assume you are on the latest version, but even if not I am confident this worked the very first time the feature was introduced.

However, if it really doesn't work, maybe it's related to something having changed in clap.

[jcornaz]

Thanks for the reply. I confirm it doesn't work:

> cargo changelog --version
cargo-changelog 0.7.0
> cargo changelog --without commit-details --without commit-statistics
error: The argument '--without <WITHOUT>...' was provided more than once, but cannot be used multiple times

USAGE:
    cargo changelog [OPTIONS] [--] [CRATES]...

For more information try --help

[Byron]

That's interesting. Maybe you can try to build it from source, I have a feeling it's related to clap and different patch releases being compiled in. The related flag wasn't changed in quite some time and from what I see it should work.

[jcornaz]

I tried with a build from sources:

• It works using the sources on the main branch (9c1e38bfcffea372f06c78a44b2abc2284b7a87e)
• It doesn't work using sources tagged cargo-smart-release-v0.7.0

So I presume, it's a matter of releasing :-)

[Byron]

Hehe, and releasing I can do easily now 😅. I must admit that I am still a little uneasy when I see release plans like this, even though these days it's all working nicely.

[WARN ] Consider running with --update-crates-index to assure bumping on demand uses the latest information
[INFO ] Will not publish or alter 2 dependent crates: unchanged = 'git-validate', 'git-lock'
[INFO ] WOULD auto-bump dependent package 'git-hash' from 0.9.0 to 0.9.1 for publishing
[INFO ] WOULD auto-bump dependent package 'git-features' from 0.19.0 to 0.19.1 for publishing
[INFO ] Manifest version of dependent package 'git-actor' at 0.8.0 is sufficient to succeed latest released version 0.7.0, ignoring computed version 0.8.1
[INFO ] WOULD auto-bump dependent package 'git-config' from 0.1.9 to 0.1.10 for publishing
[INFO ] Manifest version of dependent package 'git-object' at 0.17.0 is sufficient to succeed latest released version 0.16.0, ignoring computed version 0.18.0
[INFO ] Manifest version of dependent package 'git-diff' at 0.13.0 is sufficient to succeed latest released version 0.12.0, ignoring computed version 0.14.0
[INFO ] WOULD auto-bump dependent package 'git-tempfile' from 1.0.3 to 1.0.4 for publishing
[INFO ] WOULD auto-bump dependent package 'git-chunk' from 0.2.0 to 0.3.0 for publishing
[INFO ] Manifest version of dependent package 'git-traverse' at 0.12.0 is sufficient to succeed latest released version 0.11.0, ignoring computed version 0.13.0
[INFO ] Manifest version of dependent package 'git-pack' at 0.16.0 is sufficient to succeed latest released version 0.15.0, ignoring computed version 0.17.0
[INFO ] Manifest version of dependent package 'git-odb' at 0.26.0 is sufficient to succeed latest released version 0.25.0, ignoring computed version 0.27.0
[INFO ] WOULD auto-bump dependent package 'git-packetline' from 0.12.2 to 0.12.3 for publishing
[INFO ] WOULD auto-bump dependent package 'git-url' from 0.3.4 to 0.3.5 for publishing
[INFO ] Manifest version of dependent package 'git-transport' at 0.15.0 is sufficient to succeed latest released version 0.14.0, ignoring computed version 0.15.1
[INFO ] Manifest version of dependent package 'git-protocol' at 0.14.0 is sufficient to succeed latest released version 0.13.0, ignoring computed version 0.14.1
[INFO ] Manifest version of dependent package 'git-ref' at 0.11.0 is sufficient to succeed latest released version 0.10.0, ignoring computed version 0.12.0
[INFO ] Manifest version of dependent package 'git-repository' at 0.14.0 is sufficient to succeed latest released version 0.13.0, ignoring computed version 0.15.0
[INFO ] Manifest version of provided package 'cargo-smart-release' at 0.8.0 is sufficient to succeed latest released version 0.7.0, ignoring computed version 0.9.0
[INFO ] WOULD adjust version constraints in manifests of 8 packages as direct dependencies are changing: git-testtools, git-commitgraph, git-index, gitoxide-core, object-access, diffing, traversal, gitoxide
[WARN ] git-hash: The following tags were not encountered during commit graph traversal: refs/tags/git-hash-v0.4.0
[INFO ] WOULD modify existing changelog for 'git-hash'.
[INFO ] WOULD modify existing changelog for 'git-features'.
[INFO ] WOULD modify existing changelog for 'git-actor'.
[INFO ] WOULD modify existing changelog for 'git-config'.
[INFO ] WOULD modify existing changelog for 'git-object'.
[INFO ] WOULD modify existing changelog for 'git-diff'.
[INFO ] WOULD modify existing changelog for 'git-tempfile'.
[INFO ] WOULD modify existing changelog for 'git-chunk'.
[INFO ] WOULD modify existing changelog for 'git-traverse'.
[INFO ] WOULD modify existing changelog for 'git-pack'.
[INFO ] WOULD modify existing changelog for 'git-odb'.
[INFO ] WOULD modify existing changelog for 'git-packetline'.
[INFO ] WOULD modify existing changelog for 'git-url'.
[INFO ] WOULD modify existing changelog for 'git-transport'.
[INFO ] WOULD modify existing changelog for 'git-protocol'.
[INFO ] WOULD modify existing changelog for 'git-ref'.
[INFO ] WOULD modify existing changelog for 'git-repository'.
[INFO ] WOULD modify existing changelog for 'cargo-smart-release'.
[INFO ] Up to 18 changelogs would be previewed if the --execute is set and --no-changelog-preview is unset.

[Byron]

Something that really needs to be changed though is the 'retry 3 times till failure' to get around the relative laziness of the updates to crates.io. Previously published crates aren't yet available and causing crates that depend on them to fail publishing. Even though it's OK to just retry, now with changelog support one will have the statistics section updated with one new commit that is just related to the release itself. See #316 .

Ideally the mechanism would be overhauled to more properly wait for crates.io updates to come in, code for this exists in cargo-release I think.

After all of this, a new release of cargo-smart-release is now available :).