githooks: create commit message template with prepare-commit-msg #44872

VallariAg · 2022-02-02T21:17:21Z

Resolves https://tracker.ceph.com/issues/51537

For files changes in src/abc/xyz/file.ext, abcd/file2.txt, and file3.txt, this would create a template with the file path (and remove the redundant "/src" part):

# Please enter the commit message for your changes.
# abc/xyz: <commit_message>
# abcd: <commit_message>
# file3.txt: <commit_message>

The developer can simply uncomment the most relevant lines and replace <commit_message> with their message text.

To use git hooks, configure git to use githooks directory instead of .git/hooks/ (reason: maintaining git hooks in repository) by running:

git config core.hooksPath githooks

Checklist

Tracker (select at least one)
- References tracker ticket
- Very recent bug; references commit where it was introduced
- New feature (ticket optional)
- Doc update (no ticket needed)
- Code cleanup (no ticket needed)
Component impact
- Affects Dashboard, opened tracker ticket
- Affects Orchestrator, opened tracker ticket
- No impact that needs to be tracked
Documentation (select at least one)
- Updates relevant documentation
- No doc update is appropriate
Tests (select at least one)
- Includes unit test(s)
- Includes integration test(s)
- Includes bug reproducer
- No tests

Show available Jenkins commands

jenkins retest this please
jenkins test classic perf
jenkins test crimson perf
jenkins test signed
jenkins test make check
jenkins test make check arm64
jenkins test submodules
jenkins test dashboard
jenkins test dashboard cephadm
jenkins test api
jenkins test docs
jenkins render docs
jenkins test ceph-volume all
jenkins test ceph-volume tox

ideepika · 2022-02-07T14:12:39Z

@VallariAg this is awesome, thanks for the contribution!

I was just curious why didn't you use .git/hooks directory itself?

I tried your PR locally, we are not retaining default github comments, can we do a append to commit message defaults that github has, instead of complete template replacing?
Another thing, I'd like to see if possible would be Signed-off-by auto append, for example please read about git commit signing.
We'd need to amend the commit in this PR as well with a git commit sign.

VallariAg · 2022-02-07T14:40:32Z

Hey @ideepika, thank you!

I was just curious why didn't you use .git/hooks directory itself?

Scripts inside.git/hooks/ are not version controlled so they cannot be commited to the repo. So, I came across this solution, to store these scripts in a directory which can be tracked by git.
I think, we would need to add command git config core.hooksPath githooks to the installation script for these hooks to be used by everyone.

can we do a append to commit message defaults that github has, instead of complete template replacing?
I'd like to see if possible would be Signed-off-by auto append,

Awesome, I'll make these changes!

We'd need to amend the commit in this PR as well with a git commit sign.

My bad, I'll edit my commit message with the changes you mentioned above.

Resolves https://tracker.ceph.com/issues/51537 Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

VallariAg · 2022-02-09T21:46:35Z

Added the "signed-off-by" and the default commit message text.
For changes on a file /test.txt, it creates the following commit message:

# Possible commit messages: 
# test.txt: <commit_message>

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch test
# Changes to be committed:
#       new file:   test.txt
#
# Changes not staged for commit:
#       modified:   githooks/prepare-commit-msg
#       modified:   install-deps.sh
#
# Untracked files:
#       # Possible commit messages: 
#       gpg-key.asc
#       gpg-key.pub
#

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

ideepika · 2022-02-15T12:19:14Z

@VallariAg thanks for the update, added minor changes needs, looks good overall!

ideepika · 2022-02-15T12:14:10Z

githooks/prepare-commit-msg

 fi

+
+# Adds a Signed-off-by line to the message, that can still be edited (This is rarely a good idea).
+SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')


users most times use git commit -s to add signed off by line, can add a check for if signed-off-by is specified/present already in the commit message file; then do not add new.

Another thing I noticed was, doing a git amend adds a duplicate signed-off by as well; the above approach should also resolve that issue as well.

Agree with @ideepika, most users alreay include the -s or alias the commit -s command.

However, what we can do here is, apart from this hook, create a complementary pre-commit hook (if you write both in Python you can share most of the code from a third file) that basically detects:

the commit message follows the format: component: subject (and component has to match a list of predefined components obtained from the path-component mapping file)

check the commit title length (<72 chars).

Basically everything else required here.

Fixes: (not mandatory)

Signed-off-by:.

There are tools that already do this, but they are mostly for semantic commits, a convention we are not adhered to (it's configurable though).

Oh, adding a complimentary hook to check the commit message is an awesome idea!
I think we would be going for the commit-msg hook, as they run in order: pre-commit -> prepare-commit-msg -> commit-msg.

Both hooks in python, got it!

ideepika · 2022-02-15T12:18:17Z

githooks/prepare-commit-msg

  done
+  sed -i "1s;^;$COMMIT_MSG_HEADERS\n;" $COMMIT_MSG_FILE


It would be nice to have the commit message headers after signed-off by, a developer would be able to then identify more clearly if the commit is signed or not, and will not have to check after text the git default template.

epuertat

Thanks a lot @VallariAg for your magnificent contribution here! 🥳 I left a few suggestions over there.

epuertat · 2022-02-21T16:51:13Z

githooks/prepare-commit-msg

@@ -0,0 +1,43 @@
+#!/usr/bin/sh


Suggested change

#!/usr/bin/sh

#!/usr/bin/env sh

Or bash

epuertat · 2022-02-21T16:57:48Z

githooks/prepare-commit-msg

+COMMIT_MSG_FILE=$1
+COMMIT_SOURCE=$2
+SHA1=$3


Have you tested this with a commit template? I'm asking because many people use that and I tried and it bypasses this. It might be interesting to check if there's a way to make both things work together.

I haven't tried using commit templates, I'll try and test that!

epuertat · 2022-02-21T17:54:37Z

githooks/prepare-commit-msg

+    # src/<project>/file.txt - "<project>:"
+    # file.txt               - "file.txt:"
+    # <project>/file.txt     - "<project>:" 
+    COMMIT_MSG_HEADERS+="\n$(echo "# $FILE: <commit_message>" | sed -E 's|src/+||g' | sed -r 's/(.*)(\/[a-z0-9.-]+)/\1 /')" 


We already have a couple of files where we map paths to Github teams, and to Github labels.

I'm not advocating for a third file mapping paths to components, but... yeah, on a second thought, it makes all the sense, right? These files are not changed that often to become tedious to keep them in sync.

While sed supports for script files, at this point in complexity I'd consider rewriting this in Python. With a CSV reader and a file pattern matching library, you could easily read the mappings from a file:

doc/* doc src/mon/* mon ... src/pybind/mgr/dashboard/* mgr/dashboard

BONUS 1: Additionally it'd be great not to show the same component multiple times:

# Possible commit messages: # pybind/mgr/dashboard : <commit_message> # pybind/mgr/dashboard : <commit_message> # mon: <commit_message>

If you implement this in Python it's quite easy to perform the deduplication and only show 1 line per component.

BONUS 2: If you count the number of occurrences per component, you can also suggest first the component with most files changed. Let's say a commit changed "src/mon/file1, src/cephfs/file2 and src/cephfs/file3", so we display first the component with more files modified (cephfs):

# Possible commit messages: # cephfs : <commit_message> # mon: <commit_message>

Python 3.6 and above brings in a new class collections.Counter exactly for this purpose.

Creating a file for mapping paths to component sounds like a great idea! Yeah, keeping them in sync should not be a problem.
Sounds awesome, doing this in python makes sense.

epuertat · 2022-02-21T17:55:28Z

githooks/prepare-commit-msg

 fi

+
+# Adds a Signed-off-by line to the message, that can still be edited (This is rarely a good idea).
+SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')


Agree with @ideepika, most users alreay include the -s or alias the commit -s command.

However, what we can do here is, apart from this hook, create a complementary pre-commit hook (if you write both in Python you can share most of the code from a third file) that basically detects:

the commit message follows the format: component: subject (and component has to match a list of predefined components obtained from the path-component mapping file)

check the commit title length (<72 chars).

Basically everything else required here.

Fixes: (not mandatory)

Signed-off-by:.

There are tools that already do this, but they are mostly for semantic commits, a convention we are not adhered to (it's configurable though).

epuertat · 2022-02-21T18:08:33Z

githooks/prepare-commit-msg

+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+


It's always better to write safer shell scripts:

Suggested change

set -euxo pipefail

epuertat · 2022-02-21T18:14:26Z

@VallariAg regarding the file location, if you assume that users might have their own hooks in .git/hooks then the idea of changing the config is less feasible. So what I usually do here is creating symlinks from the hooks to files in the repo, and to make things more user-friendly you can provide a script (or document the command) for automating that.

VallariAg · 2022-02-21T23:12:23Z

@VallariAg regarding the file location, if you assume that users might have their own hooks in .git/hooks then the idea of changing the config is less feasible. So what I usually do here is creating symlinks from the hooks to files in the repo, and to make things more user-friendly you can provide a script (or document the command) for automating that.

Oh, yes, that makes sense! symlinks it is, then.

To use these scripts, run: - chmod +x githooks/prepare-commit-msg - ln -s githooks/* .git/hooks/ Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

github-actions · 2022-08-25T23:01:37Z

This pull request has been automatically marked as stale because it has not had any activity for 60 days. It will be closed if no further activity occurs for another 30 days.
If you are a maintainer or core committer, please follow-up on this pull request to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

VallariAg · 2022-08-25T23:33:23Z

I've pushed some of the work I did on this, using python scripts to achieve the suggested results.

Though while working on this, I realized I need to re-approach a part of how commit-msgs are editing messages because of unexpected results in few cases (example: using "--amend" doesn't show the commit message template and use of these hooks with "-m" needs more customization).
I'll get back to this soon! This would really be a convenient feature to have. Sorry for the lack of activity on this one!
When it's ready for review, I'll change it back to open PR from draft PR.

github-actions · 2023-01-27T08:01:51Z

This pull request has been automatically marked as stale because it has not had any activity for 60 days. It will be closed if no further activity occurs for another 30 days.
If you are a maintainer or core committer, please follow-up on this pull request to identify what steps should be taken by the author to move this proposed change forward.
If you are the author of this pull request, thank you for your proposed contribution. If you believe this change is still appropriate, please ensure that any feedback has been addressed and ask for a code review.

github-actions · 2023-02-26T09:01:30Z

This pull request has been automatically closed because there has been no activity for 90 days. Please feel free to reopen this pull request (or open a new one) if the proposed change is still appropriate. Thank you for your contribution!

neha-ojha requested a review from ideepika February 3, 2022 00:09

batrick added the build/ops label Feb 4, 2022

VallariAg force-pushed the prepare-commit-msg branch from 06d6308 to a521e14 Compare February 9, 2022 20:03

VallariAg added 2 commits February 10, 2022 01:37

githooks: Create commit message template with prepare-commit-msg

ab7c7df

Resolves https://tracker.ceph.com/issues/51537 Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

githooks: add SOB and default commit message text

f951d75

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

VallariAg force-pushed the prepare-commit-msg branch from a521e14 to f951d75 Compare February 9, 2022 21:38

ideepika reviewed Feb 15, 2022

View reviewed changes

epuertat reviewed Feb 21, 2022

View reviewed changes

epuertat added the GSoC / Outreachy label Apr 22, 2022

djgalloway changed the base branch from master to main May 25, 2022 20:03

VallariAg added 2 commits August 5, 2022 22:19

githooks: Add prepare-commit-msg hook in python script

028c3f9

To use these scripts, run: - chmod +x githooks/prepare-commit-msg - ln -s githooks/* .git/hooks/ Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

githook: Add commit-msg hook

83b0c48

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>

github-actions bot added the stale label Aug 25, 2022

VallariAg marked this pull request as draft August 25, 2022 23:11

github-actions bot removed the stale label Aug 26, 2022

github-actions bot added the stale label Jan 27, 2023

github-actions bot closed this Feb 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

githooks: create commit message template with prepare-commit-msg #44872

githooks: create commit message template with prepare-commit-msg #44872

VallariAg commented Feb 2, 2022 •

edited

ideepika commented Feb 7, 2022 •

edited

VallariAg commented Feb 7, 2022

VallariAg commented Feb 9, 2022

ideepika commented Feb 15, 2022

ideepika Feb 15, 2022

epuertat Feb 21, 2022

VallariAg Feb 21, 2022

ideepika Feb 15, 2022 •

edited

epuertat left a comment

epuertat Feb 21, 2022

epuertat Feb 21, 2022

VallariAg Feb 21, 2022

epuertat Feb 21, 2022

VallariAg Feb 21, 2022

epuertat Feb 21, 2022

epuertat Feb 21, 2022

epuertat commented Feb 21, 2022

VallariAg commented Feb 21, 2022

github-actions bot commented Aug 25, 2022

VallariAg commented Aug 25, 2022

github-actions bot commented Jan 27, 2023

github-actions bot commented Feb 26, 2023

githooks: create commit message template with prepare-commit-msg #44872

githooks: create commit message template with prepare-commit-msg #44872

Conversation

VallariAg commented Feb 2, 2022 • edited

Checklist

ideepika commented Feb 7, 2022 • edited

VallariAg commented Feb 7, 2022

VallariAg commented Feb 9, 2022

ideepika commented Feb 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ideepika Feb 15, 2022 • edited

Choose a reason for hiding this comment

epuertat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

epuertat commented Feb 21, 2022

VallariAg commented Feb 21, 2022

github-actions bot commented Aug 25, 2022

VallariAg commented Aug 25, 2022

github-actions bot commented Jan 27, 2023

github-actions bot commented Feb 26, 2023

VallariAg commented Feb 2, 2022 •

edited

ideepika commented Feb 7, 2022 •

edited

ideepika Feb 15, 2022 •

edited