Skip to content

Git Burn is a server-side hook for linting commits.

License

Notifications You must be signed in to change notification settings

Invizory/git-burn

Repository files navigation

Git Burn

Build status Snap version License

Git Burn is a server-side hook for linting commits.

Features · Install · Integrations · Copyright

In case of fire

Features

  • Highly opinionated, zero-configuration commit linter.
  • Based on some gitlint rules.
  • Checks the rules from the article «How to Write a Git Commit Message».
  • Checks for issue references.
  • Checks commit emails for presence in the user database. Only GitLab is supported now.

Install

snap install git-burn --classic

Note that you should have snapd installed.

Set up hook with GitLab

To set a global hook for all repositories:

install -dm 0755 -o git -g git /var/opt/gitlab/snap
ln -fs "$(which git-burn)" /opt/gitlab/embedded/service/gitlab-shell/hooks/update.d

Please refer to GitLab documentation on server-side hooks for details.

Integrations

GitLab integration

Obtain GitLab personal access token first. Go to GitLab web interface → User Settings → Access Tokens. Give it a name like “git-burn”, check only “read_user” scope, and create a token.

GitLab screenshot

Then just run on GitLab Shell machine:

snap set git-burn gitlab.url="https://…" gitlab.token="…"

Copyright

Copyright © 2018–2019 Arthur Khashaev. See license for details.

About

Git Burn is a server-side hook for linting commits.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published