qualiaa / git-automation

Custom git automation scripts and configs

Git Automation Tools

A few tools for client-side git automation.

• Hooks for automatic linting, building and testing.
• An info/exclude file ignoring many common non-SCM files.
• Simple config for automatic code formatting via clean filters,

Specifically, the staged version of Python and C++ code is reformatted when staged with git add, leaving your local copy unchanged. When you commit code, the staged versions of all changed files are validated according to your configuration, with a lot of formats ready out of the box. Finally, before a push, a small number of known build tools and test suites are checked if present.

Requirements

The clean filters use clang-format for C/C++ and black for Python. The pre-commit hook requires the Hash::Union perl module, which can be installed with:

sudo cpan Hash::Union

The pre-commit hook runs a number of linters if available, and can be configured for more; see the default configuration. The current list of pre-configured linters is:

• pylint
• flake8
• shellcheck
• stylelint
• eslint
• xmllint
• jq
• yamllint

Install

To one project

Per project, just dump the files in your repo:

hooks             => .git/hooks
info              => .git/info
gitconfig         => .gitconfig
gitattributes     => .gitattributes
commit-tests.yaml => commit-tests.yaml

For your user

To install the clean filter for your user, merge gitconfig and gitattributes with their equivalents in $HOME or $XDG_CONFIG_HOME/git, or see Clean filters.

To install hooks and info for your user, you need to set up your own git template directory - read the GIT TEMPLATES section of [[https://git-scm.com/docs/git-init][~man git-init]]. If you have root privileges, you can easily set them up System-wide instead.

Once the git template is configured, it will be installed automatically to repositories created with git init - for existing repositories, git init will install them without overwriting existing files.

System-wide

To install the clean filter for your user, merge gitconfig and gitattributes with their equivalents in /etc, or see Clean filters.

To install the hooks and info system-wide:

hooks => /usr/share/git-core/templates/hooks
info  => /usr/share/git-core/templates/info

Once the hooks are installed to a template, they will be installed into any new repositories automatically.

Once the git template is configured, it will be installed automatically to repositories created with git init - for existing repositories, git init will install them without overwriting existing files.

Configuration

Pre-commit

The pre-commit hook reads commit-tests.yaml in the root of the repository if present. The default configuration is here.

Pre-push

The pre-push hook is not currently configurable, it isn’t very smart. If you know simple shell you can probably add your own tools to the script directly.

Clean filters

The clean filters are simple - you can recreate the gitconfig easily:

git config filter.cpp.clean "clang-format --style=Google"
git config filter.py.clean  "black -"

You can pass git config the flags --global to install for your user or --system to install for your system (requires root).

If you conform to one style but your organisation another, you can configure a clean filter to use their style, and a matching smudge filter which converts back to your style.

The =gitattributes= file is just a list of globs binding files to filters, see ~man gitattributes~.

Future Work and Known Issues

• The pre-commit hook needs pre- and post-actions for different languages, e.g. to source a Python virtual environment before linting.
• Some tools OR flags (e.g. PyLint), which leads to confusing flags.
• The pre-push hook is rudimentary and needs further tool support.
• The pre-push hook currently crashes if pytest is not installed.