Skip to main content

A set of tools to validate conventional commit messages.

Project description

Commit Message Git Hook

Installation Instructions

1. Using the Local Git Hook commit-msg

  1. Create a folder called git-hooks in your project repository. For example, inside the .github directory:
mkdir -p ./.github/git-hooks
  1. Create the commit-msg git-hook file:
touch ./.github/git-hooks/commit-msg
  1. And then paste this content in it:
#!/usr/bin/env python3

import commit_msg as cm

cm.main()
  1. Now run the command below in the repository root to set your repository git hooks path:
git config core.hooksPath .github/git-hooks

NOTE: The configuration is local to this repository. Each repo can have its own hooks path.

2. Using the Server-Side Scan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commit_msg_git_hook-0.0.1.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

commit_msg_git_hook-0.0.1-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page