mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
# Pre-commit
|
|
|
|
## TL;DR
|
|
|
|
```sh
|
|
# Generate a very basic configuration.
|
|
pre-commit sample-config > .pre-commit-config.yaml
|
|
|
|
# Manually run checks.
|
|
pre-commit run --all-files
|
|
pre-commit run ansible-lint --files ansible/
|
|
|
|
# Automatically run checks at every commit.
|
|
pre-commit install
|
|
|
|
# Update all hooks to the latest version.
|
|
pre-commit autoupdate
|
|
|
|
# Skip check on commit.
|
|
SKIP=flake8 git commit -m "foo"
|
|
```
|
|
|
|
```yaml
|
|
---
|
|
# File .pre-commit-config.yaml
|
|
# See https://pre-commit.com for more information
|
|
# See https://pre-commit.com/hooks.html for more hooks
|
|
# See https://github.com/pre-commit/identify/blob/main/identify/extensions.py for the list of file types by extension
|
|
|
|
repos:
|
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
rev: v4.2.0
|
|
hooks:
|
|
- id: trailing-whitespace
|
|
args:
|
|
- --markdown-linebreak-ext=md # ignore markdown's line break
|
|
- id: end-of-file-fixer
|
|
- id: check-yaml
|
|
- id: check-added-large-files
|
|
- repo: https://github.com/markdownlint/markdownlint
|
|
rev: v0.11.0
|
|
hooks:
|
|
- id: markdownlint
|
|
types: [markdown] # limit target types
|
|
args:
|
|
- -r "~MD013" # ignore line-length rule
|
|
- repo: https://github.com/ansible-community/ansible-lint
|
|
rev: v6.0.2
|
|
hooks:
|
|
- id: ansible-lint
|
|
name: ansilint # use an alias
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Some files are skipped during a run
|
|
|
|
Check they are tracked (have been `add`ed to the repository).
|
|
|
|
## Further readings
|
|
|
|
- Pre-commit's [website]
|
|
- List of [supported hooks]
|
|
|
|
[supported hooks]: https://pre-commit.com/hooks.html
|
|
[website]: https://pre-commit.com
|
|
|
|
[file types by extension]: https://github.com/pre-commit/identify/blob/main/identify/extensions.py
|