Add yamllint to antsibull-nox and add config files, and prepare ignore.txt entries.

This commit is contained in:
Felix Fontein
2025-04-26 09:00:19 +02:00
parent f04f0c883e
commit 51a4f76f26
12 changed files with 201 additions and 1 deletions

2
.gitignore vendored
View File

@@ -4,7 +4,7 @@
# Community.crypt specific things # Community.crypt specific things
/changelogs/.plugin-cache.yaml /changelogs/.plugin-cache.yaml
/tests/integration/inventory/ /tests/integration/inventory
# Created by https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv # Created by https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs,dotenv

53
.yamllint Normal file
View File

@@ -0,0 +1,53 @@
---
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
extends: default
ignore: |
/changelogs/
rules:
line-length:
max: 300
level: error
document-start:
present: true
document-end: false
truthy:
level: error
allowed-values:
- 'true'
- 'false'
indentation:
spaces: 2
indent-sequences: true
key-duplicates: enable
trailing-spaces: enable
new-line-at-end-of-file: disable
hyphens:
max-spaces-after: 1
empty-lines:
max: 2
max-start: 0
max-end: 0
commas:
max-spaces-before: 0
min-spaces-after: 1
max-spaces-after: 1
colons:
max-spaces-before: 0
max-spaces-after: 1
brackets:
min-spaces-inside: 0
max-spaces-inside: 0
braces:
min-spaces-inside: 0
max-spaces-inside: 1
octal-values:
forbid-implicit-octal: true
forbid-explicit-octal: true
comments:
min-spaces-from-content: 1
comments-indentation: false

54
.yamllint-docs Normal file
View File

@@ -0,0 +1,54 @@
---
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
extends: default
ignore: |
/changelogs/
rules:
line-length:
max: 160
level: error
document-start:
present: false
document-end:
present: false
truthy:
level: error
allowed-values:
- 'true'
- 'false'
indentation:
spaces: 2
indent-sequences: true
key-duplicates: enable
trailing-spaces: enable
new-line-at-end-of-file: disable
hyphens:
max-spaces-after: 1
empty-lines:
max: 2
max-start: 0
max-end: 0
commas:
max-spaces-before: 0
min-spaces-after: 1
max-spaces-after: 1
colons:
max-spaces-before: 0
max-spaces-after: 1
brackets:
min-spaces-inside: 0
max-spaces-inside: 0
braces:
min-spaces-inside: 0
max-spaces-inside: 1
octal-values:
forbid-implicit-octal: true
forbid-explicit-octal: true
comments:
min-spaces-from-content: 1
comments-indentation: false

54
.yamllint-examples Normal file
View File

@@ -0,0 +1,54 @@
---
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: 2025 Felix Fontein <felix@fontein.de>
extends: default
ignore: |
/changelogs/
rules:
line-length:
max: 160
level: error
document-start:
present: true
document-end:
present: false
truthy:
level: error
allowed-values:
- 'true'
- 'false'
indentation:
spaces: 2
indent-sequences: true
key-duplicates: enable
trailing-spaces: enable
new-line-at-end-of-file: disable
hyphens:
max-spaces-after: 1
empty-lines:
max: 2
max-start: 0
max-end: 0
commas:
max-spaces-before: 0
min-spaces-after: 1
max-spaces-after: 1
colons:
max-spaces-before: 0
max-spaces-after: 1
brackets:
min-spaces-inside: 0
max-spaces-inside: 0
braces:
min-spaces-inside: 0
max-spaces-inside: 1
octal-values:
forbid-implicit-octal: true
forbid-explicit-octal: true
comments:
min-spaces-from-content: 1
comments-indentation: false

View File

@@ -7,6 +7,17 @@
[sessions] [sessions]
[sessions.lint]
run_isort = false
run_black = false
run_flake8 = false
run_pylint = false
run_yamllint = true
yamllint_config = ".yamllint"
yamllint_config_plugins = ".yamllint-docs"
yamllint_config_plugins_examples = ".yamllint-examples"
run_mypy = false
[sessions.docs_check] [sessions.docs_check]
validate_collection_refs="all" validate_collection_refs="all"

View File

@@ -11,10 +11,14 @@ noxfile.py future-import-boilerplate
noxfile.py metaclass-boilerplate noxfile.py metaclass-boilerplate
plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_account_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error
plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/ecs_certificate.py validate-modules:invalid-documentation
plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation

View File

@@ -10,10 +10,14 @@ noxfile.py future-import-boilerplate
noxfile.py metaclass-boilerplate noxfile.py metaclass-boilerplate
plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_account_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error
plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/ecs_certificate.py validate-modules:invalid-documentation
plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation

View File

@@ -1,10 +1,14 @@
.azure-pipelines/scripts/publish-codecov.py replace-urlopen .azure-pipelines/scripts/publish-codecov.py replace-urlopen
plugins/modules/acme_account_info.py validate-modules:return-syntax-error plugins/modules/acme_account_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_create.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_info.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error plugins/modules/acme_certificate_order_validate.py validate-modules:return-syntax-error
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error plugins/modules/acme_challenge_cert_helper.py validate-modules:return-syntax-error
plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/ecs_certificate.py validate-modules:invalid-documentation
plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation

View File

@@ -1,7 +1,11 @@
.azure-pipelines/scripts/publish-codecov.py replace-urlopen .azure-pipelines/scripts/publish-codecov.py replace-urlopen
plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/ecs_certificate.py validate-modules:invalid-documentation
plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation
plugins/modules/luks_device.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation

View File

@@ -1,7 +1,11 @@
.azure-pipelines/scripts/publish-codecov.py replace-urlopen .azure-pipelines/scripts/publish-codecov.py replace-urlopen
plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation plugins/lookup/gpg_fingerprint.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/ecs_certificate.py validate-modules:invalid-documentation plugins/modules/ecs_certificate.py validate-modules:invalid-documentation
plugins/modules/get_certificate.py validate-modules:invalid-documentation plugins/modules/get_certificate.py validate-modules:invalid-documentation
plugins/modules/luks_device.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation

View File

@@ -1,6 +1,10 @@
.azure-pipelines/scripts/publish-codecov.py replace-urlopen .azure-pipelines/scripts/publish-codecov.py replace-urlopen
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/luks_device.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation
tests/ee/roles/smoke/library/smoke_ipaddress.py shebang tests/ee/roles/smoke/library/smoke_ipaddress.py shebang
tests/ee/roles/smoke/library/smoke_pyyaml.py shebang tests/ee/roles/smoke/library/smoke_pyyaml.py shebang

View File

@@ -1,5 +1,9 @@
plugins/modules/acme_certificate.py validate-modules:invalid-documentation plugins/modules/acme_certificate.py validate-modules:invalid-documentation
plugins/modules/acme_certificate.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation plugins/modules/acme_certificate_order_create.py validate-modules:invalid-documentation
plugins/modules/acme_certificate_order_create.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_finalize.py yamllint:unparsable-with-libyaml
plugins/modules/acme_certificate_order_validate.py yamllint:unparsable-with-libyaml
plugins/modules/luks_device.py validate-modules:invalid-documentation plugins/modules/luks_device.py validate-modules:invalid-documentation
tests/ee/roles/smoke/library/smoke_ipaddress.py shebang tests/ee/roles/smoke/library/smoke_ipaddress.py shebang
tests/ee/roles/smoke/library/smoke_pyyaml.py shebang tests/ee/roles/smoke/library/smoke_pyyaml.py shebang