chore(script): check message during commit #8

anis-campos · 2020-09-02T13:35:24Z

Add script that checks message from file
Add precommit hook to help python developers make good commit messages

noirbee

I think this makes sense only as a commit-msg hook, not a pre-commit one.

I doubt the hook configuration itself works as-is, given that AFAIK pre-commit passes files to hooks, not commit SHAs

check_message.sh

.pre-commit-hooks.yaml

noirbee

See comments

sebastien-boulle · 2020-09-02T20:28:01Z

README.md

@@ -242,6 +242,23 @@ jobs:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```

+## Add pre-commit plugin


I try it on the repo itself with this branch as rev, but I wasn't able to make it work :(
Also I got some linting errors

I changed the readme, maybe this is the step mising in you test :
https://github.com/lumapps/commit-message-validator/blame/chore/precommit_hook/README.md#L266

Actually without --hook-type commit-msg it can't work. I fixed the docs

- Add script that checks message from file - Add precommit hook to help python developers make goo commit messages

anis-campos · 2020-09-03T12:02:58Z

#8 (comment)

I'm finally keeping the echo message to prevent loss as describe inside the script.

anis-campos · 2020-09-03T12:07:39Z

And as discussed with @sebastien-boulle we might depreciate this in favor of a different approach:

Prepare the commit message based on the branch ( e.i. <type>/<jira_ticket>/<the-scope>_<the_subject>) via prepare-commit-msg hook
Warn of incorrect commit message ( post-commit hook)
Prevent push with a pre-push hook that validates all the commit messages of the branch and prints the errors of each one

But in the mean time let's keeps this, as I'm short in time right now to do all that

noirbee

Not much to say otherwise

noirbee · 2020-09-07T15:58:13Z

check_message.sh

+
+fi
+
+# print message so you don't loose it in case of errors


sebastien-boulle · 2020-09-07T19:26:46Z

check_message.sh

+# (in case you are not using `-m` option)
+printf "checking commit message:\n\n#BEGIN#\n%s\n#END#\n\n" "$(grep -v "#" <<< "$MESSAGE")"
+
+COMMIT_VALIDATOR_ALLOW_TEMP=1 COMMIT_VALIDATOR_NO_JIRA=1 validate "$MESSAGE"


Nope you don't want to deactivate JIRA validation

Now we can fixup locally. The github action should still block the merge though

adding the configuration necesarry to run the validator during

using validator on its own repo

anis-campos requested review from lumautomation and a team as code owners September 2, 2020 13:35

noirbee requested changes Sep 2, 2020

View reviewed changes

check_message.sh Outdated Show resolved Hide resolved

check_message.sh Outdated Show resolved Hide resolved

check_message.sh Outdated Show resolved Hide resolved

anis-campos requested a review from noirbee September 2, 2020 14:09

anis-campos force-pushed the chore/precommit_hook branch 3 times, most recently from a72f755 to 4881008 Compare September 2, 2020 16:40

anis-campos assigned noirbee Sep 2, 2020

noirbee approved these changes Sep 2, 2020

View reviewed changes

.pre-commit-hooks.yaml Outdated Show resolved Hide resolved

noirbee requested changes Sep 2, 2020

View reviewed changes

sebastien-boulle requested changes Sep 2, 2020

View reviewed changes

chore(script): check message during commit

e79cacc

- Add script that checks message from file - Add precommit hook to help python developers make goo commit messages

anis-campos force-pushed the chore/precommit_hook branch from 4881008 to af32da8 Compare September 3, 2020 07:18

anis-campos requested review from sebastien-boulle and noirbee September 3, 2020 07:29

anis-campos force-pushed the chore/precommit_hook branch from fbd6c0b to 849fd0e Compare September 3, 2020 12:00

noirbee requested changes Sep 7, 2020

View reviewed changes

check_message.sh Outdated

fi

# print message so you don't loose it in case of errors

Copy link

noirbee Sep 7, 2020

Choose a reason for hiding this comment

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

lose*

sebastien-boulle reviewed Sep 7, 2020

View reviewed changes

Anis Da Silva Campos added 2 commits September 7, 2020 22:15

chore(pre-commit): allow fixups and revert

f0eb02e

Now we can fixup locally. The github action should still block the merge though

docs(readme): explain how to setup pre-commit

01c8d9f

adding the configuration necesarry to run the validator during

sebastien-boulle force-pushed the chore/precommit_hook branch 2 times, most recently from 5eec7f2 to 3103930 Compare September 7, 2020 20:23

chore(check-message): handle options for prehook

5e29849

sebastien-boulle force-pushed the chore/precommit_hook branch from 3103930 to 5693e98 Compare September 7, 2020 20:25

Anis Da Silva Campos and others added 2 commits September 7, 2020 22:28

chore(hook): add pre-commit to validate commits

6856d2b

using validator on its own repo

chore(hook): target master for commit validation

d0de179

sebastien-boulle force-pushed the chore/precommit_hook branch from 5693e98 to d0de179 Compare September 7, 2020 20:29

sebastien-boulle approved these changes Sep 7, 2020

View reviewed changes

noirbee approved these changes Sep 8, 2020

View reviewed changes

anis-campos merged commit 2b192f3 into master Sep 8, 2020

anis-campos deleted the chore/precommit_hook branch September 8, 2020 07:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(script): check message during commit #8

chore(script): check message during commit #8

Uh oh!

anis-campos commented Sep 2, 2020 •

edited

Loading

Uh oh!

noirbee left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noirbee left a comment

Uh oh!

sebastien-boulle Sep 2, 2020

Uh oh!

anis-campos Sep 3, 2020

Uh oh!

anis-campos Sep 3, 2020 •

edited

Loading

Uh oh!

anis-campos commented Sep 3, 2020

Uh oh!

anis-campos commented Sep 3, 2020 •

edited

Loading

Uh oh!

noirbee left a comment

Uh oh!

noirbee Sep 7, 2020

Uh oh!

sebastien-boulle Sep 7, 2020

Uh oh!

Uh oh!

chore(script): check message during commit #8

chore(script): check message during commit #8

Uh oh!

Conversation

anis-campos commented Sep 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

noirbee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noirbee left a comment

Choose a reason for hiding this comment

Uh oh!

sebastien-boulle Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

anis-campos Sep 3, 2020

Choose a reason for hiding this comment

Uh oh!

anis-campos Sep 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anis-campos commented Sep 3, 2020

Uh oh!

anis-campos commented Sep 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

noirbee left a comment

Choose a reason for hiding this comment

Uh oh!

noirbee Sep 7, 2020

Choose a reason for hiding this comment

Uh oh!

sebastien-boulle Sep 7, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anis-campos commented Sep 2, 2020 •

edited

Loading

anis-campos Sep 3, 2020 •

edited

Loading

anis-campos commented Sep 3, 2020 •

edited

Loading