Run yamllint via nox. (#91)

Author: felixfontein

.github/workflows/ansible-test.yml

@@ -165,24 +165,3 @@ jobs:
         env:
           ANSIBLE_COLLECTIONS_PATH: ../../../
         working-directory: ./ansible_collections/felixfontein/acme
-
-  yamllint:
-    name: yamllint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install yamllint
-        run: |
-          pip install yamllint --disable-pip-version-check
-
-      - name: Run yamllint
-        run: yamllint .

noxfile.py

@@ -23,6 +23,16 @@
 IN_CI = "GITHUB_ACTIONS" in os.environ
 
 
+antsibull_nox.add_lint_sessions(
+    run_isort=False,
+    run_black=False,
+    run_flake8=False,
+    run_pylint=False,
+    run_yamllint=True,
+    yamllint_config=".yamllint",
+    run_mypy=False,
+)
+
 antsibull_nox.add_docs_check(
     validate_collection_refs="all",
 )

plugins/filter/_substitute_dns.py

@@ -8,29 +8,31 @@
 __metaclass__ = type
 
 DOCUMENTATION = '''
-  name: _substitute_dns
-  short_description: "[INTERNAL] Adjust DNS name according to a CNAME substitution map"
-  version_added: 0.6.0
-  author: Felix Fontein (@felixfontein)
-  description:
-    - B(This is an internal tool and must only be used from roles in this collection!)
-      If you use it from outside this collection, be warned that its behavior can change
-      and it can be removed at any time, even in bugfix releases!
-  options:
-    _input:
-      description: A DNS name.
-      type: string
-      required: true
-    substitution_map:
-      description:
-        - A map mapping DNS names to other DNS names.
-        - You can use a single wildcard C(*) as the first component of a DNS name.
-        - Trailing dots are ignored.
-      type: dict
-      required: true
+---
+name: _substitute_dns
+short_description: "[INTERNAL] Adjust DNS name according to a CNAME substitution map"
+version_added: 0.6.0
+author: Felix Fontein (@felixfontein)
+description:
+  - B(This is an internal tool and must only be used from roles in this collection!)
+    If you use it from outside this collection, be warned that its behavior can change
+    and it can be removed at any time, even in bugfix releases!
+options:
+  _input:
+    description: A DNS name.
+    type: string
+    required: true
+  substitution_map:
+    description:
+      - A map mapping DNS names to other DNS names.
+      - You can use a single wildcard C(*) as the first component of a DNS name.
+      - Trailing dots are ignored.
+    type: dict
+    required: true
 '''
 
 EXAMPLES = '''
+---
 - name: Simple replace
   ansible.builtin.set_fact:
     name: "{{ 'www.example.com' | felixfontein.acme._substitute_dns({'www.example.com': 'www.com.example.org'}) }}"
@@ -48,9 +50,10 @@
 '''
 
 RETURN = '''
-  _value:
-    description: The transformed input.
-    type: string
+---
+_value:
+  description: The transformed input.
+  type: string
 '''
 
 from ansible.errors import AnsibleFilterError, AnsibleFilterTypeError