Skip to content

Instantly share code, notes, and snippets.

@aemonge
Last active March 1, 2024 01:02
Show Gist options
  • Star 23 You must be signed in to star a gist
  • Fork 6 You must be signed in to fork a gist
  • Save aemonge/9e60332c6a3e7147ee8e to your computer and use it in GitHub Desktop.
Save aemonge/9e60332c6a3e7147ee8e to your computer and use it in GitHub Desktop.
Angular Commit Message Conventions git hook, so you got your commit prepared to with the messages they expect ;)
#!/bin/bash
firstLine=`head -2 $1 | tail -1`
if [[ $firstLine == \#* ]]; then # Testing that the file starts with a comment, not yet a real commit ;)
echo '<type>(<component>): <subject>' > .prepare-commit-msg-temp
echo '' >> .prepare-commit-msg-temp
echo '<body>' >> .prepare-commit-msg-temp
echo '' >> .prepare-commit-msg-temp
echo '# types: feat, fix, docs, style, refactor, test, chore(mantean)' >> .prepare-commit-msg-temp
{ cat .prepare-commit-msg-temp; cat $1; } > .prepare-commit-msg-temp2
cat .prepare-commit-msg-temp2 > $1
rm .prepare-commit-msg-temp .prepare-commit-msg-temp2
fi
@FranklinYu
Copy link

mantean -> maintain?

@mochadwi
Copy link

mochadwi commented Jun 2, 2019

How to use this? Do we only have to copy the script to our .git/hooks? I've tried, but no success @aemonge

@aemonge
Copy link
Author

aemonge commented Jun 3, 2019

Yes! It's supposed to do so, can you share with me your environment.

@jmaumene
Copy link

jmaumene commented Jul 31, 2020

Try to add this on the first line :

#!/bin/bash

and make runnable :

chmod +x prepare-commit-msg

@aemonge
Copy link
Author

aemonge commented Aug 3, 2020

Thanks ! (I've made the change)

@stephyswe
Copy link

A proper way to show case how to use this git commit boilerplate convention and add it step by step to your own project would reduce questions further users will have.

@aemonge
Copy link
Author

aemonge commented Jul 15, 2021

:)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment