absolute-version / commit-and-tag-version

Fork of the excellent standard-version. Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org :trophy:
ISC License
360 stars 33 forks source link

feat: Add signoff option #120

Closed mbwhite closed 6 months ago

mbwhite commented 6 months ago

Our current process required that the git commit --signoff is used to add a signed-off-by trailer to the commit message.

Adding an additional CLI option to permit this to be added.

TimothyJones commented 6 months ago

npm run format:fix will fix the build error

mbwhite commented 6 months ago

This is great, thanks so much for the PR! AND documentation and tests! 🙌🎉

I left a couple questions inline - Also, do you think the argument would be better named —signoff, to match the git argument that people might be looking for?

thanks :-)

I'd debated with myself on that exact question. Using --signoff to match git as you say is valid... but I settled on --signedoff as I was worried that it was very close to the tools --sign option.

Would commit-and-tag-version --sign --signoff be confusing?

Happy to go within either spelling :-)

codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (cd0f921) 94.42% compared to head (42b05bc) 94.43%. Report is 1 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #120 +/- ## ========================================== + Coverage 94.42% 94.43% +0.01% ========================================== Files 25 25 Lines 466 467 +1 ========================================== + Hits 440 441 +1 Misses 26 26 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

TimothyJones commented 6 months ago

I see what you are saying about the ambiguity, but I reckon that’s a risk either way.

Even if the alternative is more ambiguous, I reckon that the consistency with git is worth it.

mbwhite commented 6 months ago

Thanks @TimothyJones

TimothyJones commented 6 months ago

Thank you for the contribution! Releasing 12.1.0 now, should be live shortly.