Skip to content

feat: add signoff parameter to commit command #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2021
Merged

feat: add signoff parameter to commit command #439

merged 2 commits into from
Oct 6, 2021

Conversation

manang
Copy link
Contributor

@manang manang commented Sep 29, 2021

command to sign off the commit, equivalent to git commit -s

This feature permits to execute "git commit -s" command

Description

when cz commit --signoff is launched, the command git commit -s is executed

Checklist

  • Add test cases to all the changes you introduce
  • Run ./script/format and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

Signed-off-by message added to the footer of the commit

command to sign off the commit, equivalent to git commit -s
@manang manang mentioned this pull request Sep 29, 2021
@Lee-W Lee-W requested a review from woile September 30, 2021 05:32
@codecov
Copy link

codecov bot commented Sep 30, 2021

Codecov Report

Merging #439 (7b7b0c9) into master (ca0e4bc) will increase coverage by 0.01%.
The diff coverage is 100.00%.

❗ Current head 7b7b0c9 differs from pull request most recent head 5e22040. Consider uploading reports for the commit 5e22040 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master     #439      +/-   ##
==========================================
+ Coverage   97.90%   97.92%   +0.01%     
==========================================
  Files          39       39              
  Lines        1384     1395      +11     
==========================================
+ Hits         1355     1366      +11     
  Misses         29       29              
Flag Coverage Δ
unittests 97.92% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
commitizen/cli.py 97.61% <ø> (ø)
commitizen/__version__.py 100.00% <100.00%> (ø)
commitizen/commands/commit.py 98.41% <100.00%> (+0.07%) ⬆️
commitizen/commands/version.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 976d5d2...5e22040. Read the comment docs.

@Lee-W
Copy link
Member

Lee-W commented Sep 30, 2021

@woile I'll say this is an ok temporary solution for additional arguments. I think we'll eventually use something like --, but I'm good with this. What do you think?

@woile
Copy link
Member

woile commented Oct 6, 2021

I like it and I'm fine with it, only thing missing is some docs 👍🏻

add -s shortcut for the --signoff command
@woile woile merged commit 7b50f50 into commitizen-tools:master Oct 6, 2021
@woile
Copy link
Member

woile commented Oct 6, 2021

You got it! 🎉

@manang manang deleted the signoff branch October 6, 2021 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants