pre-commit-hooks

This repository is a collection of Git hooks to be used with the pre-commit framework.

• Available Hooks
  • Terraform
  • Go
  • GNU Make
  • Markdown
  • Bash
• Installation & Dependencies
• Usage
  • Run
    • Example: Run All Hooks
    • Example: Run A Specific Hook
  • Pre-Commit and Continuous Integration
  • Add Custom Hooks
• Module Versioning
  • Backwards compatibility in 0.0.z and 0.y.z version
• About Mineiros
• Reporting Issues
• Contributing
• Makefile Targets
• License

Available Hooks

Currently, the following hooks are supported:

Terraform

• terraform-fmt: The terraform fmt command is used to rewrite Terraform configuration *.tf files to a canonical format and style.
• terraform-validate: The terraform validate command validates all Terraform configuration *.tf files, referring only to the configuration and not accessing any remote services such as remote state, provider APIs, etc.
• tflint: TFLint is a Terraform linter focused on possible errors, best practices, etc. (Terraform >= 0.12). Applied to all Terraform configuration *.tf files.

Go

• golangci-lint: GolangCI-Lint is a linters aggregator. It's fast: on average 5 times faster than gometalinter. It's easy to integrate and use, has nice output and has a minimum number of false positives. An example configuration can be found in .golangci.example.yml.

The following hooks can be configured through golangci-lint and are therefore redundant when golangci-lint is being used

• gofmt: Go fmt is a tool that automatically formats Go *.go files to canonical format and style.
• goimports: The goimports command updates import lines in Go *.go files, adding missing ones and removing unreferenced ones.

GNU Make

• phony-targets: This hook validates if targets that are marked as PHONY actually exist.

Markdown

• markdown-link-check: Validates that all hyperlinks in a markdown text alive or dead.

Bash

• shellcheck: ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts.

Terradoc

• terradoc-fmt: The terradoc fmt command is used to rewrite Terradoc configuration configuration *.tfdoc.hcl files to a canonical format and style.
• terradoc-generate: The terradoc generate command generates a markdown document from Terradoc configuration *.tfdoc.hcl files.
• terradoc-validate: The terradoc validate command is used validate Terradoc configuration in README.tfdoc.hcl file against Terraform variable definitions.

Terramate

• terramate-fmt: The terramate generate command formats code in Terramate configuration files.
• terramate-generate: The terramate generate command generates code from Terramate configuration files.

Installation & Dependencies

1. Install pre-commit. E.g. brew install pre-commit

2. Install Terraform, TFLint, Go, markdown-link-check, shellcheck. E.g

     brew install terraform \
         tflint \
         go \
         golangci/tap/golangci-lint \
         shellcheck && \
         npm install -g markdown-link-check && \
         go install github.com/mineiros-io/terradoc/cmd/terradoc@latest

Usage

Create a .pre-commit-config.yaml inside your repositories and add the desired list of hooks. Please see the documentation for further information.

repos:
  - repo: https://github.com/mineiros-io/pre-commit-hooks
    rev: <VERSION> # Check for the latest version: https://github.com/mineiros-io/pre-commit-hooks/releases
    hooks:
      - id: terraform-fmt
      - id: terraform-validate
      - id: tflint
      - id: golangci-lint
      - id: phony-targets
      - id: markdown-link-check
        args: [-p] # When adding the -p flag, markdown-link-check will always with an exit code 0, even if dead links are found
      - id: shellcheck
      - id: terradoc-validate
      - id: terradoc-fmt
      - id: terradoc-generate
      - id: terramate-generate

      # The following hooks are redundant when golangci-lint is being. Our recommendation is to use golangci-lint
      # as the main linter for go since it enables you to run all available linters in parallel.
      # For details please see the example configuration https://github.com/mineiros-io/pre-commit-hooks/blob/master/.golangci.example.yml
      # - id: gofmt
      # - id: goimports

Once you created the configuration file inside your repository, you must run pre-commit install to activate the hooks. That's it, pre-commit will now listen for changes in your files and run the checks accordingly.

Run

It's usually a good idea to run the hooks against all of the files when adding new hooks (usually pre-commit will only run on the changed files during git hooks).

Example: Run All Hooks

pre-commit run --all-files

Example: Run A Specific Hook

pre-commit run terraform-validate --all-files

Pre-Commit and Continuous Integration

It's recommended to run pre-commit as part of CI pipeline/build as there will be always that one rebel in the team who won't run them locally. On CI, replace pre-commit install by pre-commit run -a. We don't need to install it on CI as it'll be a one-shot operation. run -a will run the hooks over all files (taking into account excludes if configured).

Add Custom Hooks

All *.sh files inside pre_commit_hooks need to be flagged as executable. Otherwise the pre-commit hooks won't be executable by default. You apply the flag to all *.sh files with the following command:

find pre_commit_hooks/ -type f -iname "*.sh" -exec chmod +x {} \;

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

1. Use the MAJOR version for incompatible changes.
2. Use the MINOR version when adding functionality in a backwards compatible manner.
3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

About Mineiros

Mineiros is a DevOps as a Service company based in Berlin, Germany. We offer commercial support for all of our projects and encourage you to reach out if you have any questions or need help. Feel free to send us an email at hello@mineiros.io.

We can also help you with:

• Terraform modules for all types of infrastructure such as VPCs, Docker clusters, databases, logging and monitoring, CI, etc.
• Consulting & training on AWS, Terraform and DevOps

Reporting Issues

We use GitHub Issues to track community reported issues and missing features.

Contributing

Contributions are always encouraged and welcome! For the process of accepting changes, we use Pull Requests. If you'd like more information, please see our Contribution Guidelines.

Makefile Targets

This repository comes with a handy Makefile. Run make help to see details on each available target.

License

This module is licensed under the Apache License Version 2.0, January 2004. Please see LICENSE for full details.

Copyright © 2020 Mineiros GmbH