forked from aristanetworks/avd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.pre-commit-config.yaml
219 lines (201 loc) · 8.7 KB
/
.pre-commit-config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
ci:
autoupdate_commit_msg: "CI: pre-commit autoupdate"
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: trailing-whitespace
name: Trims trailing whitespace.
exclude: ansible_collections/arista/avd/molecule
- id: end-of-file-fixer
name: Ensures that a file is either empty, or ends with one newline.
exclude_types: [svg, json]
exclude: ansible_collections/arista/avd/molecule
- id: check-added-large-files
name: Prevents giant files from being committed.
exclude: (ansible_collections/arista/avd/molecule|pickle$|python-avd/pyavd/_(eos_cli_config_gen|eos_designs)/schema/__init__.py)
- id: check-merge-conflict
name: Checks for files that contain merge conflict strings.
exclude: ansible_collections/arista/avd/molecule
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.5.5
hooks:
- id: insert-license
name: Check and insert license on Python files.
exclude: ansible_collections/arista/avd/(plugins/module_utils|tests/unit(/module_utils|/modules|))/__init__.py
files: .*\.py$
args:
- --license-filepath
- development/license-short.txt
- --use-current-year
- --allow-past-years
- --fuzzy-match-generates-todo
- --no-extra-eol
- id: insert-license
name: Check and insert license on select YAML files.
files: ansible_collections/arista/avd/roles/.*/(handlers|schemas|tasks)/.*\.yml$
args:
- --license-filepath
- development/license-short.txt
- --use-current-year
- --allow-past-years
- --fuzzy-match-generates-todo
- --no-extra-eol
- id: insert-license
name: Check and insert license on Jinja2 files.
files: .*\.j2$
exclude: ansible_collections/arista/avd/molecule.*
args:
- --license-filepath
- development/license-short.txt
- --use-current-year
- --allow-past-years
- --fuzzy-match-generates-todo
- --comment-style
- '{#||#}'
- --no-extra-eol
- id: insert-license
name: Check and insert license on Markdown files.
files: .*\.md$
exclude: (ansible_collections/arista/avd/molecule|.github|ansible_collections/arista/avd/examples/.+/documentation/).*
args:
- --license-filepath
- development/license-short.txt
- --use-current-year
- --allow-past-years
- --fuzzy-match-generates-todo
- --comment-style
- '<!--| ~| -->'
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.9.7
hooks:
# Run the linter.
- id: ruff
args:
- --fix
# Run the formatter.
- id: ruff-format
- repo: https://github.com/pycqa/pylint
rev: "v3.3.4"
hooks:
- id: pylint # Use pylintrc file in repository
name: Check for Linting errors on Python files outside the Ansible collection.
description: This hook runs pylint.
types: [python]
- id: pylint # Use pylintrc file in Ansible collection
name: Check for Linting errors on Python files in the Ansible collection.
description: This hook runs pylint.
types: [python]
files: ansible_collections/arista/avd/
args:
- --rcfile=ansible_collections/arista/avd/pylintrc
- repo: https://github.com/adrienverge/yamllint.git
rev: "v1.35.1"
hooks:
- id: yamllint
name: Check for Linting errors on YAML files with settings defined in `.github/yamllintrc`.
description: This hook runs yamllint.
entry: yamllint
language: python
types: [file, yaml]
args: [--strict, -c=.github/yamllintrc]
- repo: https://github.com/aristanetworks/j2lint.git
rev: "v1.1.0"
hooks:
- id: j2lint
name: Check for Linting errors on Jinja2 files
- repo: https://github.com/codespell-project/codespell
rev: v2.4.1
hooks:
- id: codespell
name: Check for common misspellings in text files.
entry: codespell
language: python
types: [text]
args:
- '--ignore-words=.github/ignore-codespell-words' # Ignore words listed in this file
exclude: > # List of regex patterns for files/directories to exclude
(?x)^(
.*\.cfg| # Exclude all .cfg files
.*\.svg| # Exclude all .svg files
.*\.excalidraw| # Exclude all .excalidraw files
.*\.rst| # Exclude all .rst files
python-avd/pyavd/vendor/.*| # Exclude all files in this directory
ansible_collections/arista/avd/CHANGELOG.rst| # Exclude auto generated CHANGELOG.rst file
ansible_collections/arista/avd/changelogs/.*| # Exclude all files in this directory
ansible_collections/arista/avd/roles/.*/docs/tables/.*\.md| # Exclude all .md files in tables
python-avd/pyavd/.*/schema/.*schema\.yml| # Exclude YAML schemas file
python-avd/pyavd/_cv/api/.*| # Exclude auto generated files for CV API
python-avd/pyavd/_cv/extra_cv_protos/.*| # Exclude extra CV proto files
docs/plugins/.* | # Excluded auto generated doc for Ansible plugins
)$
- repo: local
hooks:
- id: docs-plugin-modules
name: Build documentation for collection modules and action plugins.
entry: >-
ansible-doc-extractor --template docs/templates/plugin-docs.j2
--markdown "docs/plugins/Modules_and_action_plugins/"
language: python
types: [python]
additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
files: ansible_collections/arista/avd/plugins/modules/
- id: docs-plugin-filter
name: Build documentation for collection filter plugins.
entry: >-
ansible-doc-extractor --template docs/templates/plugin-docs.j2
--markdown "docs/plugins/Filter_plugins/"
language: python
types_or: [python, yaml]
additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
files: ansible_collections/arista/avd/plugins/filter/
exclude: ^(ansible_collections/arista/avd/plugins/filter/deprecated_filters.py)$
- id: docs-plugin-lookup
name: Build documentation for collection lookup plugins.
entry: >-
ansible-doc-extractor --template docs/templates/plugin-docs.j2
--markdown "docs/plugins/Lookup_plugins/"
language: python
types: [python]
additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
files: ansible_collections/arista/avd/plugins/lookup/
- id: docs-plugin-test
name: Build documentation for collection test plugins.
entry: >-
ansible-doc-extractor --template docs/templates/plugin-docs.j2
--markdown "docs/plugins/Test_plugins/"
language: python
types: [python]
additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
files: ansible_collections/arista/avd/plugins/test/
- id: docs-plugin-vars
name: Build documentation for collection var plugins.
entry: >-
ansible-doc-extractor --template docs/templates/plugin-docs.j2
--markdown "docs/plugins/Vars_plugins/"
language: python
types: [python]
additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0']
files: ansible_collections/arista/avd/plugins/vars/
- id: schemas
name: Build AVD schemas and documentation.
entry: sh -c 'exec python-avd/scripts/build_schemas.py'
language: python
files: python-avd/pyavd/[a-z_]+/schema
pass_filenames: false
additional_dependencies: ['deepmerge>=1.1.0', 'PyYAML>=6.0.0', 'pydantic>=2.3.0', 'jsonschema-rs>=0.24', 'referencing>=0.35.0', 'ruff==0.7.2']
- id: templates
name: Precompile Jinja2 templates
entry: sh -c 'python-avd/scripts/compile_templates.py'
language: python
files: python-avd/pyavd/(_eos_cli_config_gen|_eos_designs)/j2templates/
pass_filenames: false
additional_dependencies: ['Jinja2>=3.0.0', 'cryptography>=38.0.4', 'deepmerge>=1.1.0']
- repo: https://github.com/DavidAnson/markdownlint-cli2
rev: v0.17.2
hooks:
- id: markdownlint-cli2
name: Check for Linting errors on Markdown files with settings defined in `.github/.markdownlint.yaml`.