feat(bump): added support for running arbitrary hooks during bump #644

skoef · 2022-12-21T15:18:35Z

Description

To make commitizen integrate even better, new configuration keys hooks_pre_bump and hooks_post_bump were added to allow to run arbitrary commands prior to and right after running bump.

I've backported the work done by @janw and slightly adjusted it:

updated the patch to apply against the latest version of commitizen
run hooks_pre_bump hooks after the versions have been updated but before they are committed and tagged, so additional documentation can be generated with the new version or other generators can be run and staged.
I couldn't think of a usecase why you would want to hook into the process of generating the changelog so I completely removed this part.

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

Steps to Test This Pull Request

Add something like this in your commitizen config file:

[tool.commitizen]
hooks_pre_bump = [
  "touch foo.bar",
  "git add foo.bar"
]

Run cz bump and notice the Running hook output
Run git show HEAD to see foo.bar is part of the latest release

Additional context

Closes: #292
Thanks to @janw to do the heavy lifting here.

codecov · 2022-12-21T15:57:42Z

Codecov Report

Base: 97.92% // Head: 98.01% // Increases project coverage by +0.09% 🎉

Coverage data is based on head (e26293c) compared to base (619e2d2).
Patch coverage: 90.90% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #644      +/-   ##
==========================================
+ Coverage   97.92%   98.01%   +0.09%     
==========================================
  Files          35       40       +5     
  Lines        1252     1715     +463     
==========================================
+ Hits         1226     1681     +455     
- Misses         26       34       +8

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

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

Impacted Files	Coverage Δ
commitizen/commands/init.py	`87.93% <84.00%> (-3.74%)`	⬇️
commitizen/hooks.py	`95.45% <95.45%> (ø)`
commitizen/__version__.py	`100.00% <100.00%> (ø)`
commitizen/cmd.py	`100.00% <100.00%> (ø)`
commitizen/commands/bump.py	`97.41% <100.00%> (+0.10%)`	⬆️
commitizen/commands/check.py	`100.00% <100.00%> (ø)`
commitizen/defaults.py	`100.00% <100.00%> (ø)`
commitizen/exceptions.py	`100.00% <100.00%> (ø)`
commitizen/__init__.py	`100.00% <0.00%> (ø)`
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Lee-W

Hi @skoef thanks for your contribution! I left a few questions. Also I like the name pre_bump_hooks a bit better

commitizen/hooks.py

Lee-W · 2022-12-29T10:30:26Z

tests/test_conf.py

@@ -73,6 +83,8 @@
    "version_files": ["commitizen/__version__.py", "pyproject.toml"],
    "style": [["pointer", "reverse"], ["question", "underline"]],
    "changelog_file": "CHANGELOG.md",
+    "hooks_pre_bump": ["scripts/generate_documentation.sh"],
+    "hooks_post_bump": ["scripts/slack_notification.sh"],


I think it would be better for us to add at least one run-able test

@Lee-W I fully agree, but I'm not a real python dev myself and am not familiar with the pytest framework. If it wouldn't be too much work, could you perhaps pitch in here?

yep, I'll take a deeper look later and see how I can help on this :)

just added a test case to verify it

skoef · 2023-01-13T15:58:05Z

@Lee-W I'm not sure why specifically the windows check failed, but do you know if it has something to do with passing env to subprocess?

commitizen/hooks.py

Lee-W · 2023-01-21T02:33:17Z

@Lee-W I'm not sure why specifically the windows check failed, but do you know if it has something to do with passing env to subprocess?

It seems to be something related to type annotation. I just fixed it and rebase the latest master to your branch.

ysndr · 2023-01-23T14:32:56Z

@Lee-W
https://github.com/commitizen-tools/commitizen/compare/103def9d6c290afe1b0daca359581cefadce11ce..24f0f27ad7ecf1216d309ff8d7d1690528fbf4e7

this got lost in your rebase, breaking environment support again
@skoef can you cherry pick this in again?

skoef · 2023-01-23T14:42:13Z

@ysndr should be fixed now

Lee-W · 2023-01-23T15:37:32Z

@skoef would it be possible for you to do rebase from the master branch (i.e. using git rebase -i master)? Otherwise, we won't be able to merge it. Thanks!

To make commitizen integrate even better, new configuration keys pre_bump_hooks and post_bump_hooks were added to allow to run arbitrary commands prior to and right after running bump Closes: commitizen-tools#292

skoef · 2023-01-23T18:29:44Z

@Lee-W done!

Uses PR'd fork with support for `post_bump_hooks` [1] [1]: commitizen-tools/commitizen#644

Lee-W

Thanks @skoef for your contribution! @woile I've added a few test cases to this PR and I plan to merge it these days. Let me know if you want to check. Thanks~

skoef · 2023-02-08T11:37:39Z

@woile could you please take a look?

woile · 2023-02-08T12:39:44Z

LGTM

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke. This commit fixes that.

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke.

During development of #644, merging the hook environment variables with existing OS variables broke.

skoef force-pushed the add-hooks-for-bump-command branch 2 times, most recently from 5ea9ba7 to 36d184a Compare December 21, 2022 15:52

Lee-W added the pr-status: wait-for-review label Dec 29, 2022

Lee-W reviewed Dec 29, 2022

View reviewed changes

Lee-W added issue-status: wait-for-response needs: test-case new to add test case to prove the functionality pr-status: wait-for-review and removed pr-status: wait-for-review issue-status: wait-for-response labels Dec 29, 2022

Lee-W added pr-status: wait-for-modification and removed pr-status: wait-for-review labels Jan 5, 2023

skoef force-pushed the add-hooks-for-bump-command branch 2 times, most recently from 992a80e to 103def9 Compare January 7, 2023 10:34

ysndr suggested changes Jan 18, 2023

View reviewed changes

commitizen/hooks.py Show resolved Hide resolved

skoef force-pushed the add-hooks-for-bump-command branch from 103def9 to 24f0f27 Compare January 18, 2023 22:20

Lee-W self-assigned this Jan 19, 2023

Lee-W force-pushed the add-hooks-for-bump-command branch from 24f0f27 to 90bed7c Compare January 21, 2023 02:32

feat(bump): added support for running arbitrary hooks during bump

26b38be

To make commitizen integrate even better, new configuration keys pre_bump_hooks and post_bump_hooks were added to allow to run arbitrary commands prior to and right after running bump Closes: commitizen-tools#292

skoef force-pushed the add-hooks-for-bump-command branch from 70494a3 to 26b38be Compare January 23, 2023 17:25

ysndr added a commit to flox/runix that referenced this pull request Jan 26, 2023

ci: Add commitizen integration (#134)

cd43c36

Uses PR'd fork with support for `post_bump_hooks` [1] [1]: commitizen-tools/commitizen#644

ysndr added a commit to flox/runix that referenced this pull request Jan 26, 2023

ci: Add commitizen integration (#134)

7e2b4e0

Uses PR'd fork with support for `post_bump_hooks` [1] [1]: commitizen-tools/commitizen#644

Lee-W added 2 commits January 27, 2023 12:34

test(commands/bump): add test case from bump hooks

ba2efac

test(hooks): add test case for run

e26293c

Lee-W added wait-for-merge and removed needs: test-case new to add test case to prove the functionality pr-status: wait-for-modification labels Jan 28, 2023

Lee-W approved these changes Jan 28, 2023

View reviewed changes

Lee-W merged commit da0ea0e into commitizen-tools:master Feb 8, 2023

skoef added a commit to skoef/commitizen that referenced this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks

9c6eec2

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke. This commit fixes that.

skoef mentioned this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks #675

Merged

skoef added a commit to skoef/commitizen that referenced this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks

bfc012b

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke. This commit fixes that.

skoef added a commit to skoef/commitizen that referenced this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks

d7c5337

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke. This commit fixes that.

skoef added a commit to skoef/commitizen that referenced this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks

dab8a7f

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke.

skoef added a commit to skoef/commitizen that referenced this pull request Feb 23, 2023

fix(bump): fixed environment variables in bump hooks

6659aba

During development of commitizen-tools#644, merging the hook environment variables with existing OS variables broke.

Lee-W pushed a commit that referenced this pull request Feb 25, 2023

fix(bump): fixed environment variables in bump hooks

3ce4ed8

During development of #644, merging the hook environment variables with existing OS variables broke.

Uh oh!

feat(bump): added support for running arbitrary hooks during bump #644

feat(bump): added support for running arbitrary hooks during bump #644

Uh oh!

Conversation

skoef commented Dec 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Steps to Test This Pull Request

Additional context

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Lee-W Dec 29, 2022

Choose a reason for hiding this comment

Uh oh!

skoef Dec 30, 2022

Choose a reason for hiding this comment

Uh oh!

Lee-W Dec 31, 2022

Choose a reason for hiding this comment

Uh oh!

Lee-W Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

skoef commented Jan 13, 2023

Uh oh!

Uh oh!

Lee-W commented Jan 21, 2023

Uh oh!

ysndr commented Jan 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skoef commented Jan 23, 2023

Uh oh!

Lee-W commented Jan 23, 2023

Uh oh!

skoef commented Jan 23, 2023

Uh oh!

Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

skoef commented Feb 8, 2023

Uh oh!

woile commented Feb 8, 2023

Uh oh!

Uh oh!

skoef commented Dec 21, 2022 •

edited

Loading

codecov bot commented Dec 21, 2022 •

edited

Loading

ysndr commented Jan 23, 2023 •

edited

Loading