antsibull-nox 0.4.0__tar.gz → 0.6.0__tar.gz

{antsibull_nox-0.4.0 → antsibull_nox-0.6.0}/.github/workflows/nox.yml

@@ -49,6 +49,12 @@ jobs:
         with:
           path: antsibull-nox
           persist-credentials: false
+      - name: Check out dependent project antsibull-docutils
+        uses: actions/checkout@v4
+        with:
+          repository: ansible-community/antsibull-docutils
+          path: antsibull-docutils
+          persist-credentials: false
       - name: Check out dependent project antsibull-fileutils
         uses: actions/checkout@v4
         with:

antsibull_nox-0.4.0/docs/changelog.md → antsibull_nox-0.6.0/CHANGELOG.md

@@ -1,9 +1,86 @@
 # Antsibull Nox Helper Release Notes
 
+**Topics**
+
+- <a href="#v0-6-0">v0\.6\.0</a>
+    - <a href="#release-summary">Release Summary</a>
+    - <a href="#minor-changes">Minor Changes</a>
+    - <a href="#bugfixes">Bugfixes</a>
+- <a href="#v0-5-0">v0\.5\.0</a>
+    - <a href="#release-summary-1">Release Summary</a>
+    - <a href="#minor-changes-1">Minor Changes</a>
+    - <a href="#bugfixes-1">Bugfixes</a>
+- <a href="#v0-4-0">v0\.4\.0</a>
+    - <a href="#release-summary-2">Release Summary</a>
+    - <a href="#major-changes">Major Changes</a>
+    - <a href="#minor-changes-2">Minor Changes</a>
+    - <a href="#bugfixes-2">Bugfixes</a>
+- <a href="#v0-3-0">v0\.3\.0</a>
+    - <a href="#release-summary-3">Release Summary</a>
+    - <a href="#minor-changes-3">Minor Changes</a>
+    - <a href="#removed-features-previously-deprecated">Removed Features \(previously deprecated\)</a>
+    - <a href="#bugfixes-3">Bugfixes</a>
+- <a href="#v0-2-0">v0\.2\.0</a>
+    - <a href="#release-summary-4">Release Summary</a>
+    - <a href="#major-changes-1">Major Changes</a>
+    - <a href="#minor-changes-4">Minor Changes</a>
+    - <a href="#deprecated-features">Deprecated Features</a>
+- <a href="#v0-1-0">v0\.1\.0</a>
+    - <a href="#release-summary-5">Release Summary</a>
+    - <a href="#minor-changes-5">Minor Changes</a>
+    - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
+    - <a href="#bugfixes-4">Bugfixes</a>
+- <a href="#v0-0-1">v0\.0\.1</a>
+    - <a href="#release-summary-6">Release Summary</a>
+
+<a id="v0-6-0"></a>
+## v0\.6\.0
+
+<a id="release-summary"></a>
+### Release Summary
+
+Bugfix and feature release\.
+
+<a id="minor-changes"></a>
+### Minor Changes
+
+* Add new extra check <code>no\-trailing\-whitespace</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+* Add new options to <code>docs\-check</code> that allow to validate code blocks in collection extra docs \([https\://github\.com/ansible\-community/antsibull\-nox/pull/88](https\://github\.com/ansible\-community/antsibull\-nox/pull/88)\)\.
+* Support running <code>ruff check \-\-fix \-\-select \.\.\.</code> in the <code>formatters</code> session by setting <code>run\_ruff\_autofix\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* Support running <code>ruff check</code> in the <code>codeqa</code> session by setting <code>run\_ruff\_check\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* Support running <code>ruff format</code> in the <code>formatters</code> session by setting <code>run\_ruff\_format\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* The <code>yamllint</code> test now also checks YAML and YAML\+Jinja code blocks in extra documentation \(<code>\.rst</code> files in <code>docs/docsite/rst/</code>\) \([https\://github\.com/ansible\-community/antsibull\-nox/pull/87](https\://github\.com/ansible\-community/antsibull\-nox/pull/87)\)\.
+
+<a id="bugfixes"></a>
+### Bugfixes
+
+* Do not fail if an unexpected action group is found that only contains a metadata entry \([https\://github\.com/ansible\-community/antsibull\-nox/pull/81](https\://github\.com/ansible\-community/antsibull\-nox/pull/81)\)\.
+* Fix config file types for <code>no\_unwanted\_files\_skip\_directories</code> and <code>no\_unwanted\_files\_yaml\_directories</code> to what is documented\; that is\, do not allow <code>None</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+* Ignore metadata entries in action groups \([https\://github\.com/ansible\-community/antsibull\-nox/pull/81](https\://github\.com/ansible\-community/antsibull\-nox/pull/81)\)\.
+* The <code>no\_unwanted\_files\_skip\_directories</code> option for the <code>no\-unwanted\-files</code> was not used \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+
+<a id="v0-5-0"></a>
+## v0\.5\.0
+
+<a id="release-summary-1"></a>
+### Release Summary
+
+Feature and bugfix release\.
+
+<a id="minor-changes-1"></a>
+### Minor Changes
+
+* Allow to pass environment variables as Ansible variables for integration tests with the new <code>ansible\_vars\_from\_env\_vars</code> option for <code>sessions\.ansible\_test\_integration\_w\_default\_container</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/78](https\://github\.com/ansible\-community/antsibull\-nox/pull/78)\)\.
+
+<a id="bugfixes-1"></a>
+### Bugfixes
+
+* Fix action group test\. No errors were reported due to a bug in the test \([https\://github\.com/ansible\-community/antsibull\-nox/pull/80](https\://github\.com/ansible\-community/antsibull\-nox/pull/80)\)\.
+
 <a id="v0-4-0"></a>
 ## v0\.4\.0
 
-<a id="release-summary"></a>
+<a id="release-summary-2"></a>
 ### Release Summary
 
 Feature and bugfix release\.
@@ -13,7 +90,7 @@ Feature and bugfix release\.
 
 * Required collections can now be installed from different sources per depending on the ansible\-core version \([https\://github\.com/ansible\-community/antsibull\-nox/pull/76](https\://github\.com/ansible\-community/antsibull\-nox/pull/76)\)\.
 
-<a id="minor-changes"></a>
+<a id="minor-changes-2"></a>
 ### Minor Changes
 
 * Capture mypy and pylint errors to report paths of files relative to collection\'s root\, instead of relative to the virtual <code>ansible\_collections</code> directory \([https\://github\.com/ansible\-community/antsibull\-nox/pull/75](https\://github\.com/ansible\-community/antsibull\-nox/pull/75)\)\.
@@ -22,7 +99,7 @@ Feature and bugfix release\.
 * The yamllint session now ignores <code>RETURN</code> documentation with values <code>\#</code> and \`\` \# \`\` \([https\://github\.com/ansible\-community/antsibull\-nox/pull/71](https\://github\.com/ansible\-community/antsibull\-nox/pull/71)\)\.
 * The yamllint test no longer shows all filenames in the command line \([https\://github\.com/ansible\-community/antsibull\-nox/pull/72](https\://github\.com/ansible\-community/antsibull\-nox/pull/72)\)\.
 
-<a id="bugfixes"></a>
+<a id="bugfixes-2"></a>
 ### Bugfixes
 
 * Adjust yamllint test to no longer use the user\'s global config\, but only the project\'s config \([https\://github\.com/ansible\-community/antsibull\-nox/pull/72](https\://github\.com/ansible\-community/antsibull\-nox/pull/72)\)\.
@@ -30,7 +107,7 @@ Feature and bugfix release\.
 <a id="v0-3-0"></a>
 ## v0\.3\.0
 
-<a id="release-summary-1"></a>
+<a id="release-summary-3"></a>
 ### Release Summary
 
 Feature release that is stabilizing the API\.
@@ -38,7 +115,7 @@ Feature release that is stabilizing the API\.
 All noxfiles and configs using this version should still work with antsibull\-nox 1\.0\.0\,
 unless a critical problem is found that cannot be solved in any other way\.
 
-<a id="minor-changes-1"></a>
+<a id="minor-changes-3"></a>
 ### Minor Changes
 
 * Add <code>antsibull\-nox init</code> command that creates a <code>noxfile\.py</code> and <code>antsibull\-nox\.tomll</code> to get started \([https\://github\.com/ansible\-community/antsibull\-nox/pull/58](https\://github\.com/ansible\-community/antsibull\-nox/pull/58)\)\.
@@ -57,7 +134,7 @@ unless a critical problem is found that cannot be solved in any other way\.
 
 * Removed all deprecated functions from <code>antsibull\_nox\.\*\*</code> that generate sessions\. The only functions left that are public API are <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code>\, <code>antsibull\_nox\.add\_ansible\_test\_session\(\)</code>\, and <code>antsibull\_nox\.sessions\.prepare\_collections\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/54](https\://github\.com/ansible\-community/antsibull\-nox/pull/54)\)\.
 
-<a id="bugfixes-1"></a>
+<a id="bugfixes-3"></a>
 ### Bugfixes
 
 * Action groups extra test no longer fails if <code>action\_groups</code> does not exist in <code>meta/runtime\.yml</code>\. It can now be used to ensure that there is no action group present in <code>meta/runtime\.yml</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/60](https\://github\.com/ansible\-community/antsibull\-nox/pull/60)\)\.
@@ -68,7 +145,7 @@ unless a critical problem is found that cannot be solved in any other way\.
 <a id="v0-2-0"></a>
 ## v0\.2\.0
 
-<a id="release-summary-2"></a>
+<a id="release-summary-4"></a>
 ### Release Summary
 
 Major extension and overhaul with many breaking changes\. The next minor release is expected to bring more stabilization\.
@@ -78,7 +155,7 @@ Major extension and overhaul with many breaking changes\. The next minor release
 
 * There is now a new function <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code> which loads <code>antsibull\-nox\.toml</code> and creates configuration and sessions from it\. Calling other functionality from <code>antsibull\_nox</code> in <code>noxfile\.py</code> is only necessary for creating own specialized sessions\, or ansible\-test sessions that cannot be created with the <code>antsibull\_nox\.add\_all\_ansible\_test\_\*\_test\_sessions\*\(\)</code> type functions \([https\://github\.com/ansible\-community/antsibull\-nox/pull/50](https\://github\.com/ansible\-community/antsibull\-nox/pull/50)\, [https\://github\.com/ansible\-community/antsibull\-nox/issues/34](https\://github\.com/ansible\-community/antsibull\-nox/issues/34)\)\.
 
-<a id="minor-changes-2"></a>
+<a id="minor-changes-4"></a>
 ### Minor Changes
 
 * Add descriptions to generated sessions that are shown when running <code>nox \-\-list</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/31](https\://github\.com/ansible\-community/antsibull\-nox/pull/31)\)\.
@@ -104,12 +181,12 @@ Major extension and overhaul with many breaking changes\. The next minor release
 <a id="v0-1-0"></a>
 ## v0\.1\.0
 
-<a id="release-summary-3"></a>
+<a id="release-summary-5"></a>
 ### Release Summary
 
 Feature release\.
 
-<a id="minor-changes-3"></a>
+<a id="minor-changes-5"></a>
 ### Minor Changes
 
 * A <code>build\-import\-check</code> session that builds and tries to import the collection with Galaxy Importer can be added with <code>add\_build\_import\_check\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/issues/15](https\://github\.com/ansible\-community/antsibull\-nox/issues/15)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/17](https\://github\.com/ansible\-community/antsibull\-nox/pull/17)\)\.
@@ -128,7 +205,7 @@ Feature release\.
 
 * The nox workflow now by default runs all sessions\, unless restricted with the <code>sessions</code> parameter \([https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
 
-<a id="bugfixes-2"></a>
+<a id="bugfixes-4"></a>
 ### Bugfixes
 
 * Make sure that black in CI checks formatting instead of just reformatting \([https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
@@ -136,7 +213,7 @@ Feature release\.
 <a id="v0-0-1"></a>
 ## v0\.0\.1
 
-<a id="release-summary-4"></a>
+<a id="release-summary-6"></a>
 ### Release Summary
 
 Initial alpha release\.

{antsibull_nox-0.4.0 → antsibull_nox-0.6.0}/CHANGELOG.rst

@@ -4,6 +4,50 @@ Antsibull Nox Helper Release Notes
 
 .. contents:: Topics
 
+v0.6.0
+======
+
+Release Summary
+---------------
+
+Bugfix and feature release.
+
+Minor Changes
+-------------
+
+- Add new extra check ``no-trailing-whitespace`` (https://github.com/ansible-community/antsibull-nox/pull/85).
+- Add new options to ``docs-check`` that allow to validate code blocks in collection extra docs (https://github.com/ansible-community/antsibull-nox/pull/88).
+- Support running ``ruff check --fix --select ...`` in the ``formatters`` session by setting ``run_ruff_autofix=true`` in the config (https://github.com/ansible-community/antsibull-nox/issues/70, https://github.com/ansible-community/antsibull-nox/pull/82).
+- Support running ``ruff check`` in the ``codeqa`` session by setting ``run_ruff_check=true`` in the config (https://github.com/ansible-community/antsibull-nox/issues/70, https://github.com/ansible-community/antsibull-nox/pull/82).
+- Support running ``ruff format`` in the ``formatters`` session by setting ``run_ruff_format=true`` in the config (https://github.com/ansible-community/antsibull-nox/issues/70, https://github.com/ansible-community/antsibull-nox/pull/82).
+- The ``yamllint`` test now also checks YAML and YAML+Jinja code blocks in extra documentation (``.rst`` files in ``docs/docsite/rst/``) (https://github.com/ansible-community/antsibull-nox/pull/87).
+
+Bugfixes
+--------
+
+- Do not fail if an unexpected action group is found that only contains a metadata entry (https://github.com/ansible-community/antsibull-nox/pull/81).
+- Fix config file types for ``no_unwanted_files_skip_directories`` and ``no_unwanted_files_yaml_directories`` to what is documented; that is, do not allow ``None`` (https://github.com/ansible-community/antsibull-nox/pull/85).
+- Ignore metadata entries in action groups (https://github.com/ansible-community/antsibull-nox/pull/81).
+- The ``no_unwanted_files_skip_directories`` option for the ``no-unwanted-files`` was not used (https://github.com/ansible-community/antsibull-nox/pull/85).
+
+v0.5.0
+======
+
+Release Summary
+---------------
+
+Feature and bugfix release.
+
+Minor Changes
+-------------
+
+- Allow to pass environment variables as Ansible variables for integration tests with the new ``ansible_vars_from_env_vars`` option for ``sessions.ansible_test_integration_w_default_container`` (https://github.com/ansible-community/antsibull-nox/pull/78).
+
+Bugfixes
+--------
+
+- Fix action group test. No errors were reported due to a bug in the test (https://github.com/ansible-community/antsibull-nox/pull/80).
+
 v0.4.0
 ======
 

{antsibull_nox-0.4.0 → antsibull_nox-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antsibull-nox
-Version: 0.4.0
+Version: 0.6.0
 Summary: Changelog tool for Ansible-core and Ansible collections
 Project-URL: Documentation, https://ansible.readthedocs.io/projects/antsibull-nox/
 Project-URL: Source code, https://github.com/ansible-community/antsibull-nox/
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
-Requires-Dist: antsibull-fileutils<2.0.0,>=1.2.0
+Requires-Dist: antsibull-fileutils<2.0.0,>=1.3.0
 Requires-Dist: nox>=2025.2.9
 Requires-Dist: packaging
 Requires-Dist: pydantic~=2.0
@@ -38,6 +38,7 @@ Provides-Extra: coverage
 Requires-Dist: coverage[toml]; extra == 'coverage'
 Provides-Extra: dev
 Requires-Dist: antsibull-changelog; extra == 'dev'
+Requires-Dist: antsibull-docutils>=1.2.0; extra == 'dev'
 Requires-Dist: black>=24; extra == 'dev'
 Requires-Dist: coverage[toml]; extra == 'dev'
 Requires-Dist: flake8>=3.8.0; extra == 'dev'
@@ -58,6 +59,7 @@ Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: pytest-error-for-skips; extra == 'test'
 Provides-Extra: typing
+Requires-Dist: antsibull-docutils>=1.2.0; extra == 'typing'
 Requires-Dist: mypy; extra == 'typing'
 Requires-Dist: types-pyyaml; extra == 'typing'
 Description-Content-Type: text/markdown
@@ -104,15 +106,15 @@ and install the requirements needed to run the tests there.
 
 ---
 
-antsibull-nox depends on the sister antsibull-fileutils project.
-By default, `nox` will install a development version of this project from Github.
-If you're hacking on antsibull-fileutils alongside antsibull-nox,
-nox will automatically install this project from `../antsibull-fileutils`
+antsibull-nox depends on the sister antsibull-docutils and antsibull-fileutils projects.
+By default, `nox` will install development versions of this projects from Github.
+If you're hacking on antsibull-docutils and/or antsibull-fileutils alongside antsibull-nox,
+nox will automatically install these projects from `../antsibull-docutils` and `../antsibull-fileutils`
 when running tests if those paths exist.
 You can change this behavior through the `OTHER_ANTSIBULL_MODE` env var:
 
 - `OTHER_ANTSIBULL_MODE=auto` — the default behavior described above
-- `OTHER_ANTSIBULL_MODE=local` — install the project from `../antsibull-fileutils`.
+- `OTHER_ANTSIBULL_MODE=local` — install the projects from `../antsibull-docutils` and `../antsibull-fileutils`.
   Fail if that path doesn't exist.
 - `OTHER_ANTSIBULL_MODE=git` — install the projects from the Github main branch
 - `OTHER_ANTSIBULL_MODE=pypi` — install the latest versions from PyPI

{antsibull_nox-0.4.0 → antsibull_nox-0.6.0}/README.md

@@ -40,15 +40,15 @@ and install the requirements needed to run the tests there.
 
 ---
 
-antsibull-nox depends on the sister antsibull-fileutils project.
-By default, `nox` will install a development version of this project from Github.
-If you're hacking on antsibull-fileutils alongside antsibull-nox,
-nox will automatically install this project from `../antsibull-fileutils`
+antsibull-nox depends on the sister antsibull-docutils and antsibull-fileutils projects.
+By default, `nox` will install development versions of this projects from Github.
+If you're hacking on antsibull-docutils and/or antsibull-fileutils alongside antsibull-nox,
+nox will automatically install these projects from `../antsibull-docutils` and `../antsibull-fileutils`
 when running tests if those paths exist.
 You can change this behavior through the `OTHER_ANTSIBULL_MODE` env var:
 
 - `OTHER_ANTSIBULL_MODE=auto` — the default behavior described above
-- `OTHER_ANTSIBULL_MODE=local` — install the project from `../antsibull-fileutils`.
+- `OTHER_ANTSIBULL_MODE=local` — install the projects from `../antsibull-docutils` and `../antsibull-fileutils`.
   Fail if that path doesn't exist.
 - `OTHER_ANTSIBULL_MODE=git` — install the projects from the Github main branch
 - `OTHER_ANTSIBULL_MODE=pypi` — install the latest versions from PyPI

{antsibull_nox-0.4.0 → antsibull_nox-0.6.0}/changelogs/changelog.yaml

@@ -204,3 +204,52 @@ releases:
       - 75-mypy-pylint-errors.yml
       - 76-collection-per-ansible-core-version.yml
     release_date: '2025-05-06'
+  0.5.0:
+    changes:
+      bugfixes:
+        - Fix action group test. No errors were reported due to a bug in the test
+          (https://github.com/ansible-community/antsibull-nox/pull/80).
+      minor_changes:
+        - Allow to pass environment variables as Ansible variables for integration
+          tests with the new ``ansible_vars_from_env_vars`` option for ``sessions.ansible_test_integration_w_default_container``
+          (https://github.com/ansible-community/antsibull-nox/pull/78).
+      release_summary: Feature and bugfix release.
+    fragments:
+      - 0.5.0.yml
+      - 78-env-vars-integration-tests.yml
+      - 80-action-groups.yml
+    release_date: '2025-05-18'
+  0.6.0:
+    changes:
+      bugfixes:
+        - Do not fail if an unexpected action group is found that only contains a
+          metadata entry (https://github.com/ansible-community/antsibull-nox/pull/81).
+        - Fix config file types for ``no_unwanted_files_skip_directories`` and ``no_unwanted_files_yaml_directories``
+          to what is documented; that is, do not allow ``None`` (https://github.com/ansible-community/antsibull-nox/pull/85).
+        - Ignore metadata entries in action groups (https://github.com/ansible-community/antsibull-nox/pull/81).
+        - The ``no_unwanted_files_skip_directories`` option for the ``no-unwanted-files``
+          was not used (https://github.com/ansible-community/antsibull-nox/pull/85).
+      minor_changes:
+        - Add new extra check ``no-trailing-whitespace`` (https://github.com/ansible-community/antsibull-nox/pull/85).
+        - Add new options to ``docs-check`` that allow to validate code blocks in
+          collection extra docs (https://github.com/ansible-community/antsibull-nox/pull/88).
+        - Support running ``ruff check --fix --select ...`` in the ``formatters``
+          session by setting ``run_ruff_autofix=true`` in the config (https://github.com/ansible-community/antsibull-nox/issues/70,
+          https://github.com/ansible-community/antsibull-nox/pull/82).
+        - Support running ``ruff check`` in the ``codeqa`` session by setting ``run_ruff_check=true``
+          in the config (https://github.com/ansible-community/antsibull-nox/issues/70,
+          https://github.com/ansible-community/antsibull-nox/pull/82).
+        - Support running ``ruff format`` in the ``formatters`` session by setting
+          ``run_ruff_format=true`` in the config (https://github.com/ansible-community/antsibull-nox/issues/70,
+          https://github.com/ansible-community/antsibull-nox/pull/82).
+        - The ``yamllint`` test now also checks YAML and YAML+Jinja code blocks in
+          extra documentation (``.rst`` files in ``docs/docsite/rst/``) (https://github.com/ansible-community/antsibull-nox/pull/87).
+      release_summary: Bugfix and feature release.
+    fragments:
+      - 0.6.0.yml
+      - 81-action-group.yml
+      - 82-ruff.yml
+      - 85-no-trailing-whitespace.yml
+      - 87-yamllint-rst.yml
+      - 88-docs-check.yml
+    release_date: '2025-06-18'

antsibull_nox-0.4.0/CHANGELOG.md → antsibull_nox-0.6.0/docs/changelog.md

@@ -1,34 +1,53 @@
 # Antsibull Nox Helper Release Notes
 
-**Topics**
-
-- <a href="#v0-4-0">v0\.4\.0</a>
-    - <a href="#release-summary">Release Summary</a>
-    - <a href="#major-changes">Major Changes</a>
-    - <a href="#minor-changes">Minor Changes</a>
-    - <a href="#bugfixes">Bugfixes</a>
-- <a href="#v0-3-0">v0\.3\.0</a>
-    - <a href="#release-summary-1">Release Summary</a>
-    - <a href="#minor-changes-1">Minor Changes</a>
-    - <a href="#removed-features-previously-deprecated">Removed Features \(previously deprecated\)</a>
-    - <a href="#bugfixes-1">Bugfixes</a>
-- <a href="#v0-2-0">v0\.2\.0</a>
-    - <a href="#release-summary-2">Release Summary</a>
-    - <a href="#major-changes-1">Major Changes</a>
-    - <a href="#minor-changes-2">Minor Changes</a>
-    - <a href="#deprecated-features">Deprecated Features</a>
-- <a href="#v0-1-0">v0\.1\.0</a>
-    - <a href="#release-summary-3">Release Summary</a>
-    - <a href="#minor-changes-3">Minor Changes</a>
-    - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
-    - <a href="#bugfixes-2">Bugfixes</a>
-- <a href="#v0-0-1">v0\.0\.1</a>
-    - <a href="#release-summary-4">Release Summary</a>
+<a id="v0-6-0"></a>
+## v0\.6\.0
+
+<a id="release-summary"></a>
+### Release Summary
+
+Bugfix and feature release\.
+
+<a id="minor-changes"></a>
+### Minor Changes
+
+* Add new extra check <code>no\-trailing\-whitespace</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+* Add new options to <code>docs\-check</code> that allow to validate code blocks in collection extra docs \([https\://github\.com/ansible\-community/antsibull\-nox/pull/88](https\://github\.com/ansible\-community/antsibull\-nox/pull/88)\)\.
+* Support running <code>ruff check \-\-fix \-\-select \.\.\.</code> in the <code>formatters</code> session by setting <code>run\_ruff\_autofix\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* Support running <code>ruff check</code> in the <code>codeqa</code> session by setting <code>run\_ruff\_check\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* Support running <code>ruff format</code> in the <code>formatters</code> session by setting <code>run\_ruff\_format\=true</code> in the config \([https\://github\.com/ansible\-community/antsibull\-nox/issues/70](https\://github\.com/ansible\-community/antsibull\-nox/issues/70)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/82](https\://github\.com/ansible\-community/antsibull\-nox/pull/82)\)\.
+* The <code>yamllint</code> test now also checks YAML and YAML\+Jinja code blocks in extra documentation \(<code>\.rst</code> files in <code>docs/docsite/rst/</code>\) \([https\://github\.com/ansible\-community/antsibull\-nox/pull/87](https\://github\.com/ansible\-community/antsibull\-nox/pull/87)\)\.
+
+<a id="bugfixes"></a>
+### Bugfixes
+
+* Do not fail if an unexpected action group is found that only contains a metadata entry \([https\://github\.com/ansible\-community/antsibull\-nox/pull/81](https\://github\.com/ansible\-community/antsibull\-nox/pull/81)\)\.
+* Fix config file types for <code>no\_unwanted\_files\_skip\_directories</code> and <code>no\_unwanted\_files\_yaml\_directories</code> to what is documented\; that is\, do not allow <code>None</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+* Ignore metadata entries in action groups \([https\://github\.com/ansible\-community/antsibull\-nox/pull/81](https\://github\.com/ansible\-community/antsibull\-nox/pull/81)\)\.
+* The <code>no\_unwanted\_files\_skip\_directories</code> option for the <code>no\-unwanted\-files</code> was not used \([https\://github\.com/ansible\-community/antsibull\-nox/pull/85](https\://github\.com/ansible\-community/antsibull\-nox/pull/85)\)\.
+
+<a id="v0-5-0"></a>
+## v0\.5\.0
+
+<a id="release-summary-1"></a>
+### Release Summary
+
+Feature and bugfix release\.
+
+<a id="minor-changes-1"></a>
+### Minor Changes
+
+* Allow to pass environment variables as Ansible variables for integration tests with the new <code>ansible\_vars\_from\_env\_vars</code> option for <code>sessions\.ansible\_test\_integration\_w\_default\_container</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/78](https\://github\.com/ansible\-community/antsibull\-nox/pull/78)\)\.
+
+<a id="bugfixes-1"></a>
+### Bugfixes
+
+* Fix action group test\. No errors were reported due to a bug in the test \([https\://github\.com/ansible\-community/antsibull\-nox/pull/80](https\://github\.com/ansible\-community/antsibull\-nox/pull/80)\)\.
 
 <a id="v0-4-0"></a>
 ## v0\.4\.0
 
-<a id="release-summary"></a>
+<a id="release-summary-2"></a>
 ### Release Summary
 
 Feature and bugfix release\.
@@ -38,7 +57,7 @@ Feature and bugfix release\.
 
 * Required collections can now be installed from different sources per depending on the ansible\-core version \([https\://github\.com/ansible\-community/antsibull\-nox/pull/76](https\://github\.com/ansible\-community/antsibull\-nox/pull/76)\)\.
 
-<a id="minor-changes"></a>
+<a id="minor-changes-2"></a>
 ### Minor Changes
 
 * Capture mypy and pylint errors to report paths of files relative to collection\'s root\, instead of relative to the virtual <code>ansible\_collections</code> directory \([https\://github\.com/ansible\-community/antsibull\-nox/pull/75](https\://github\.com/ansible\-community/antsibull\-nox/pull/75)\)\.
@@ -47,7 +66,7 @@ Feature and bugfix release\.
 * The yamllint session now ignores <code>RETURN</code> documentation with values <code>\#</code> and \`\` \# \`\` \([https\://github\.com/ansible\-community/antsibull\-nox/pull/71](https\://github\.com/ansible\-community/antsibull\-nox/pull/71)\)\.
 * The yamllint test no longer shows all filenames in the command line \([https\://github\.com/ansible\-community/antsibull\-nox/pull/72](https\://github\.com/ansible\-community/antsibull\-nox/pull/72)\)\.
 
-<a id="bugfixes"></a>
+<a id="bugfixes-2"></a>
 ### Bugfixes
 
 * Adjust yamllint test to no longer use the user\'s global config\, but only the project\'s config \([https\://github\.com/ansible\-community/antsibull\-nox/pull/72](https\://github\.com/ansible\-community/antsibull\-nox/pull/72)\)\.
@@ -55,7 +74,7 @@ Feature and bugfix release\.
 <a id="v0-3-0"></a>
 ## v0\.3\.0
 
-<a id="release-summary-1"></a>
+<a id="release-summary-3"></a>
 ### Release Summary
 
 Feature release that is stabilizing the API\.
@@ -63,7 +82,7 @@ Feature release that is stabilizing the API\.
 All noxfiles and configs using this version should still work with antsibull\-nox 1\.0\.0\,
 unless a critical problem is found that cannot be solved in any other way\.
 
-<a id="minor-changes-1"></a>
+<a id="minor-changes-3"></a>
 ### Minor Changes
 
 * Add <code>antsibull\-nox init</code> command that creates a <code>noxfile\.py</code> and <code>antsibull\-nox\.tomll</code> to get started \([https\://github\.com/ansible\-community/antsibull\-nox/pull/58](https\://github\.com/ansible\-community/antsibull\-nox/pull/58)\)\.
@@ -82,7 +101,7 @@ unless a critical problem is found that cannot be solved in any other way\.
 
 * Removed all deprecated functions from <code>antsibull\_nox\.\*\*</code> that generate sessions\. The only functions left that are public API are <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code>\, <code>antsibull\_nox\.add\_ansible\_test\_session\(\)</code>\, and <code>antsibull\_nox\.sessions\.prepare\_collections\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/54](https\://github\.com/ansible\-community/antsibull\-nox/pull/54)\)\.
 
-<a id="bugfixes-1"></a>
+<a id="bugfixes-3"></a>
 ### Bugfixes
 
 * Action groups extra test no longer fails if <code>action\_groups</code> does not exist in <code>meta/runtime\.yml</code>\. It can now be used to ensure that there is no action group present in <code>meta/runtime\.yml</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/60](https\://github\.com/ansible\-community/antsibull\-nox/pull/60)\)\.
@@ -93,7 +112,7 @@ unless a critical problem is found that cannot be solved in any other way\.
 <a id="v0-2-0"></a>
 ## v0\.2\.0
 
-<a id="release-summary-2"></a>
+<a id="release-summary-4"></a>
 ### Release Summary
 
 Major extension and overhaul with many breaking changes\. The next minor release is expected to bring more stabilization\.
@@ -103,7 +122,7 @@ Major extension and overhaul with many breaking changes\. The next minor release
 
 * There is now a new function <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code> which loads <code>antsibull\-nox\.toml</code> and creates configuration and sessions from it\. Calling other functionality from <code>antsibull\_nox</code> in <code>noxfile\.py</code> is only necessary for creating own specialized sessions\, or ansible\-test sessions that cannot be created with the <code>antsibull\_nox\.add\_all\_ansible\_test\_\*\_test\_sessions\*\(\)</code> type functions \([https\://github\.com/ansible\-community/antsibull\-nox/pull/50](https\://github\.com/ansible\-community/antsibull\-nox/pull/50)\, [https\://github\.com/ansible\-community/antsibull\-nox/issues/34](https\://github\.com/ansible\-community/antsibull\-nox/issues/34)\)\.
 
-<a id="minor-changes-2"></a>
+<a id="minor-changes-4"></a>
 ### Minor Changes
 
 * Add descriptions to generated sessions that are shown when running <code>nox \-\-list</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/31](https\://github\.com/ansible\-community/antsibull\-nox/pull/31)\)\.
@@ -129,12 +148,12 @@ Major extension and overhaul with many breaking changes\. The next minor release
 <a id="v0-1-0"></a>
 ## v0\.1\.0
 
-<a id="release-summary-3"></a>
+<a id="release-summary-5"></a>
 ### Release Summary
 
 Feature release\.
 
-<a id="minor-changes-3"></a>
+<a id="minor-changes-5"></a>
 ### Minor Changes
 
 * A <code>build\-import\-check</code> session that builds and tries to import the collection with Galaxy Importer can be added with <code>add\_build\_import\_check\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/issues/15](https\://github\.com/ansible\-community/antsibull\-nox/issues/15)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/17](https\://github\.com/ansible\-community/antsibull\-nox/pull/17)\)\.
@@ -153,7 +172,7 @@ Feature release\.
 
 * The nox workflow now by default runs all sessions\, unless restricted with the <code>sessions</code> parameter \([https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
 
-<a id="bugfixes-2"></a>
+<a id="bugfixes-4"></a>
 ### Bugfixes
 
 * Make sure that black in CI checks formatting instead of just reformatting \([https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
@@ -161,7 +180,7 @@ Feature release\.
 <a id="v0-0-1"></a>
 ## v0\.0\.1
 
-<a id="release-summary-4"></a>
+<a id="release-summary-6"></a>
 ### Release Summary
 
 Initial alpha release\.