Sign tag #522

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

Jump to bottom

Merged

Lee-W merged 27 commits into commitizen-tools:master from gpongelli:sign_tag

Jul 22, 2022

Merged

Sign tag #522

Lee-W merged 27 commits into commitizen-tools:master from gpongelli:sign_tag

Jul 22, 2022

Conversation

gpongelli

Copy link

Contributor

@gpongelli gpongelli commented Jun 9, 2022

Description

Add tag sign feature for bump command.

Checklist

Add test cases to all the changes you introduce
Run ./scripts/format and ./scripts/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

When added the --signed-tag, bump command will sign the tag with preconfigured GPG private key.

Steps to Test This Pull Request

run cz bump --signed-tag <tag>
check with git tag -v <tag> that the stdout answer starts with gpg: Signature made string

A new method to check if the tag is signed was added to do same step of point 2 above.

Additional context

gpongelli added 4 commits

June 9, 2022 19:36

@gpongelli


 feat(bump): add signed tag support for bump command

a46aa49

@gpongelli


 docs: added new argument to docs

9f46264

@gpongelli


 test: tests for signed tag and assert for annotated tags

5934e0f

@gpongelli


 fix(test): set git to work with gpg

6db2259

@gpongelli

Copy link

Contributor Author

gpongelli commented Jun 10, 2022 •

edited

Loading

~~(削除) pipeline error seems nothing related to my changes, please let me know how to retry the jobs or how to fix them. (削除ここまで)~~

gpongelli added 3 commits

June 13, 2022 11:06

@gpongelli


 pass black, isort, flake8 checks

f26f7ae

@gpongelli


 setup a gpg key with no passphrase

43a596e

@gpongelli


 reformatted file

8d4c37b

@codecov

Copy link

codecov bot commented Jun 13, 2022 •

edited

Loading

Codecov Report

Merging #522 (5ed4d43) into master (7b69599) will increase coverage by 0.09%.
The diff coverage is 100.00%.

@@ Coverage Diff @@
## master #522 +/- ##
==========================================
+ Coverage 97.92% 98.01% +0.09% 
==========================================
 Files 39 39 
 Lines 1540 1565 +25 
==========================================
+ Hits 1508 1534 +26 
+ Misses 32 31 -1

Flag	Coverage Δ
unittests	`98.01% <100.00%> (+0.09%)`	⬆️

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

Impacted Files	Coverage Δ
commitizen/cli.py	`93.93% <ø> (ø)`
commitizen/commands/init.py	`91.66% <ø> (ø)`
commitizen/__version__.py	`100.00% <100.00%> (ø)`
commitizen/cmd.py	`100.00% <100.00%> (ø)`
commitizen/commands/bump.py	`96.42% <100.00%> (+1.23%)`	⬆️
commitizen/commands/check.py	`100.00% <100.00%> (ø)`
commitizen/cz/__init__.py	`100.00% <100.00%> (ø)`
commitizen/defaults.py	`100.00% <100.00%> (ø)`
commitizen/git.py	`100.00% <100.00%> (ø)`
... and 1 more

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 afa0d93...5ed4d43. Read the comment docs.

gpongelli added 12 commits

June 13, 2022 14:08

@gpongelli


 temp key expires in 1 day

e3c7301

@gpongelli


 avoid DecodeError on non-english execution

c5f7a3a

@gpongelli


 debug for macos github actions, to be reverted

a3af082

@gpongelli


 use same mail and name as signer info to fix macos

38bcfa9

@gpongelli


 more macos debug to be removed once solved

9a8bffd

@gpongelli


 check if key is created

82c5853

@gpongelli


 install pinentry on macos

4859b30

@gpongelli


 fix alignment

33efa2c

@gpongelli


 Darwin not working, trying macOs

37680bb

@gpongelli


 pinentry already present, check key creation

3dbde53

@gpongelli


 use RSA, on macos default fallback to elliptic curve

dc60819

@gpongelli


 remove debug parts

9a19e3f

@gpongelli

Copy link

Contributor Author

gpongelli commented Jun 13, 2022

pipeline fixed, @woile @Lee-W please review this PR, thanks.

woile

woile reviewed

Jun 23, 2022

View reviewed changes

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

Lee-W

Lee-W reviewed

Jun 24, 2022

View reviewed changes

commitizen/cmd.py Outdated Show resolved Hide resolved

tests/commands/test_bump_command.py Outdated Show resolved Hide resolved

@gpongelli gpongelli requested review from woile and Lee-W

July 14, 2022 17:10

@gpongelli


 align naming convention to git standard

9d72ea9

woile

woile reviewed

Jul 15, 2022

View reviewed changes

commitizen/cli.py Outdated Show resolved Hide resolved

@woile

Copy link

Member

woile commented Jul 15, 2022

Awesome work @gpongelli 💪🏻

@gpongelli


 Revert part of "align naming convention to git standard"

c95c08b

This reverts commit 9d72ea9.

@gpongelli


 align all to gpg_sign

b61c2a3

woile

woile approved these changes

Jul 15, 2022

View reviewed changes

Copy link

Member

@woile woile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lee-W looks good to me, if you are ok with it we merge

@gpongelli


 fix: avoid that pytest overrides existing gpg config

2dcfe66

@gpongelli

Copy link

Contributor Author

gpongelli commented Jul 15, 2022

@woile what do you think about this comment ?

gpongelli added 3 commits

July 19, 2022 15:20

@gpongelli


 feat: use chardet to get correct encoding

3bf901e

@gpongelli


 fix in case commitizen returns None

e529087

@gpongelli


 install stubs for chardet

46682ee

Lee-W

Lee-W reviewed

Jul 22, 2022

View reviewed changes

commitizen/cmd.py

return_code = process.returncode

return Command(stdout.decode(), stderr.decode(), stdout, stderr, return_code)

return Command(

stdout.decode(chardet.detect(stdout)["encoding"] or "utf-8"),

Copy link

Member

@Lee-W Lee-W Jul 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expected output of chardet.detect if it cannot detect anything? Will it be something like {'encoding': None, 'confidence': 0.99}?

Copy link

Contributor Author

@gpongelli gpongelli Jul 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expected output of chardet.detect if it cannot detect anything? Will it be something like {'encoding': None, 'confidence': 0.99}?

Yes, it returns None, that's why I've added the or clause.

It also returns None for empty content b'', like the stderr content when all goes ok, so the or is mandatory to avoid decode failures.

Let me know if this "chardet-enabled" version is ok or if you prefer the previous one (with "iso..." encoding).

Copy link

Member

@Lee-W Lee-W Jul 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just confirm it. I like the chatdet idea.

scripts/test Outdated Show resolved Hide resolved

@gpongelli gpongelli requested a review from Lee-W

July 22, 2022 15:06

@gpongelli


 types-chardet installed into pyproject

5ed4d43

Lee-W

Lee-W approved these changes

Jul 22, 2022

View reviewed changes

Copy link

Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! let's merge it and release a new version 🎉🎉🎉

@Lee-W Lee-W merged commit f61e90e into commitizen-tools:master

Jul 22, 2022

This was referenced Aug 2, 2022

Run cz init will raise UnicodeDecodeError #428

Closed

UnicodeDecodeError if commit messages contain Unicode characters #544

Closed

Labels

None yet

3 participants

@gpongelli @woile @Lee-W

Uh oh!

Sign tag #522

Sign tag #522

Uh oh!

Conversation

@gpongelli gpongelli commented Jun 9, 2022

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

Uh oh!

gpongelli commented Jun 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gpongelli commented Jun 13, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

woile commented Jul 15, 2022

Uh oh!

@woile woile left a comment

Choose a reason for hiding this comment

Uh oh!

gpongelli commented Jul 15, 2022

Uh oh!

@Lee-W Lee-W Jul 22, 2022

Choose a reason for hiding this comment

Uh oh!

@gpongelli gpongelli Jul 22, 2022

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W Jul 22, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gpongelli commented Jun 10, 2022 •

edited

Loading

codecov bot commented Jun 13, 2022 •

edited

Loading