Skip to main content

hookmaster

Project description

Hookmaster

Some nice git hooks for your pleasure.

Problem:

  • You have a policy where every commit message should mention the jira ticket it applies to. You have them in the branch name, and can't be arsed to type them manually to each commit message. Hookmaster provides you with a nice "default" commit message formatter in prepare-commit-msg hook.
  • You want to specify commands to run as different git hooks, in a file you share with your team in git.

Installation

uv tool install hookmaster

Usage

To add 'hookmaster' hooks to all projects under /my/path

hookmaster add /my/path

Now, you get a nice commit message hook that maps branch

/bugfixes/SOMETICKET-123-do-stuff

to

SOMETICKET-123: Do stuff

The hooks themselves relay the call to hookmaster, e.g. prepare-commit-msg hooks created by hookmaster looks like this:

#!/bin/sh
hookmaster prepare-commit-msg "$@"

This delegates the message creation to globally installed hookmaster application. This means fixes to hookmaster benefit all your repositories at once.

githooks.toml

For any other hooks, you can specify them in githooks.toml:

pre-commit = "python tasks.py format"

The format should be obvious.

The hook created by this will look like:

#!/bin/sh
hookmaster run pre-commit

The command hookmaster run will load the githooks.toml file, find the hook and run it. You can use command hookmaster run pre-commit to test the hook without actually committing anything.

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

hookmaster-1.4.2.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hookmaster-1.4.2-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file hookmaster-1.4.2.tar.gz.

File metadata

  • Download URL: hookmaster-1.4.2.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for hookmaster-1.4.2.tar.gz
Algorithm Hash digest
SHA256 050ac23d2ccc25f08bcd111dd37d8aff14c38205375076a13ea422a75e0b344d
MD5 8c2128c9b3bfb1f55fc4b87b9ef66b45
BLAKE2b-256 289156b5de2e53afc40b9d76b4c255e6a192527cfda103978232d4b281e8c7b3

See more details on using hashes here.

File details

Details for the file hookmaster-1.4.2-py3-none-any.whl.

File metadata

  • Download URL: hookmaster-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for hookmaster-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4d8561284f10778e73321324be2f29d8003d9a172d28845982f7ec62aa3e4344
MD5 5b1c3e584d8a96366aea21d38b974f2f
BLAKE2b-256 de0146b65d937806430525b8211e23d3e38d0067a933d5cda374a7bd4d55f8cf

See more details on using hashes here.

Supported by

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