Christophe van de Kerchove
These tests will execute the script against multiple example commit message and validate the result of the pre-commit hook.
|2 months ago|
|tests||2 months ago|
|.pre-commit-config.yaml||2 months ago|
|.pre-commit-hooks.yaml||4 months ago|
|CHANGELOG.md||2 months ago|
|Jenkinsfile||2 months ago|
|LICENSE||4 months ago|
|README.md||2 months ago|
|afcmf_commit_validation.sh||2 months ago|
pre-commit hooks to validate commit messages against the afcmf standard.
Add the following to your
.pre-commit-config.yaml in your repository:
repos: - repo: https://scm.dazzlingwrench.fxinnovation.com/fxinnovation-public/pre-commit-afcmf rev: <put version here> hooks: - id: afcmf_commit_validation
and run the following command:
pre-commit install -t commit-msg
AFCM stands for Automation Friendly Commit Message Format. Pronunciation: af-se-məf
The rationale behind these conventions is to provide a simple yet effective way to communicate changes, browse through the history of changes and automatically generate changelog files and release notes.
The following best practices were inspired by https://www.conventionalcommits.org/en/v1.0.0/ but we did make a couple of adjustments to better fit our needs.
This repository follows Semantic Versioning 2.0.0.
This repository uses pre-commit hooks.
pre-commit install pre-commit install -t commit-msg
This repository follows the afcmf standard for it's commit messages.
The changelog message is generated using the
git-extras package using the following command:
git changelog -a -t <target-version> -p