Capture
Codex
Academia
Atlas
Concepts
Identity
Tech
AWS
DevOps
Forms
Personal
Professional
Sources
Time
aliases:
- precommit
tags:
- Type/Tech/Platform/Tool
- area/tech
publish: true
version: 1.1
dateCreated: 2022-07-25, 17:09
dateModified: 2024-09-23, 11:34
from:
- "[[Tech]]"
related:
contra:
to: Pre-commit
Add pre-commit to project
- create a file named
.pre-commit-config.yamlto the root of your project
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/psf/black
rev: 22.10.0
hooks:
- id: black
- pre-commit install
git add .pre-commit-config.yamland commit to your repo and it should work.
it's usually a good idea to run the hooks against all of the files when adding new hooks (usuallypre-commitwill only run on the changed files during git hooks)
pre-commit run --all-files
CI
Add this to .pre-commit-config.yaml
ci:
autofix_commit_msg: |
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
autofix_prs: true
autoupdate_branch: ''
autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
autoupdate_schedule: weekly
skip: []
submodules: false
Hooks & Repos to use for more checks
- https://pre-commit.com/hooks.html
- ansible/ansible-lint: ansible-lint checks playbooks for practices and behavior that could potentially be improved
- detailyang/pre-commit-shell: :beers: pre commit wrapper shellcheck
- antonbabenko/pre-commit-terraform: pre-commit git hooks to take care of Terraform configurations 🇺🇦
- Yelp/detect-secrets: An enterprise friendly way of detecting and preventing secrets in code.
- markdownlint/markdownlint: Markdown lint tool
- aquasecurity/tfsec: Security scanner for your Terraform code
- google/yamlfmt: An extensible command line tool or library to format yaml files.
- ashwin153/pre-commit-vagrant: A collection of pre-commit hooks.
- norwoodj/helm-docs: A tool for automatically generating markdown documentation for helm charts# Pre-commit
Pre-commit
Not found
This page does not exist
Interactive graph
On this page
Pre-commit
Husky
Add pre-commit to project
CI
Add this to .pre-commit-config.yaml
Hooks & Repos to use for more checks