antsibull-nox 0.1.0__tar.gz → 0.3.0__tar.gz

{antsibull_nox-0.1.0 → antsibull_nox-0.3.0}/.flake8

@@ -11,3 +11,7 @@ max-line-length = 100
 statistics = True
 # These rules conflict with black
 ignore = E203, W503
+
+# Line in multi-line string is too long:
+per-file-ignores =
+    src/antsibull_nox/init.py:E501

antsibull_nox-0.3.0/.github/workflows/nox.yml

@@ -0,0 +1,74 @@
+---
+# 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: 2023 Maxwell G <maxwell@gtmx.me>
+
+name: nox
+'on':
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  # Run once per week (Monday at 03:30 UTC)
+  schedule:
+    - cron: '30 3 * * 1'
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  nox:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - session: test
+            python-versions: "3.9, 3.10, 3.11, 3.12, 3.13"
+            force-python: ""
+            codecov: true
+            packages: ""
+
+          - session: integration
+            python-versions: "3.13"
+            force-python: "3.13"
+            codecov: true
+            packages: ""
+
+          - session: lint
+            python-versions: "3.13"
+            force-python: "3.13"
+            codecov: false
+            packages: ""
+    name: "Run nox ${{ matrix.session }} session"
+    steps:
+      - name: Check out antsibull-nox
+        uses: actions/checkout@v4
+        with:
+          path: antsibull-nox
+          persist-credentials: false
+      - name: Check out dependent project antsibull-fileutils
+        uses: actions/checkout@v4
+        with:
+          repository: ansible-community/antsibull-fileutils
+          path: antsibull-fileutils
+          persist-credentials: false
+      - name: Install extra packages
+        if: "matrix.packages != ''"
+        run: |
+          sudo apt-get install -y ${{ matrix.packages }}
+      - name: Setup nox
+        uses: wntrblm/nox@2025.02.09
+        with:
+          python-versions: "${{ matrix.python-versions }}"
+      - name: Run nox
+        uses: ansible-community/github-action-run-nox@v1
+        with:
+          sessions: ${{ matrix.session }}
+          force-pythons: ${{ matrix.force-python }}
+          working-directory: antsibull-nox
+          codecov: ${{ matrix.codecov }}
+          codecov-session: coverage
+          codecov-token: ${{ secrets.CODECOV_TOKEN }}

antsibull_nox-0.3.0/.github/workflows/reusable-nox-matrix.yml

@@ -0,0 +1,162 @@
+---
+# 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>
+
+name: Run sanity, unit, and integration tests
+
+"on":
+  workflow_call:
+    inputs:
+      upload-codecov:
+        type: boolean
+        description: >-
+          Whether code coverage should be collected and uploaded to codecov.io.
+        required: false
+        default: false
+    secrets:
+      CODECOV_TOKEN:
+        required: false
+
+jobs:
+  create-matrixes:
+    name: "Create matrixes"
+    runs-on: ubuntu-latest
+    outputs:
+      sanity-matrix: ${{ fromJSON(steps.generate-matrix.outputs.run-nox).sanity }}
+      units-matrix: ${{ fromJSON(steps.generate-matrix.outputs.run-nox).units }}
+      integration-matrix: ${{ fromJSON(steps.generate-matrix.outputs.run-nox).integration }}
+    steps:
+      - name: Check out collection
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Run nox
+        uses: ansible-community/antsibull-nox@main
+        id: generate-matrix
+        with:
+          sessions: matrix-generator
+
+  sanity:
+    name: ${{ matrix.skip && 'Skipping ' || '' }}Sanity (Ⓐ${{ matrix.ansible-core }})
+    needs:
+      - create-matrixes
+    strategy:
+      matrix:
+        include: >-
+          ${{ fromJson(needs.create-matrixes.outputs.sanity-matrix || '[{"skip": true}]') }}
+    runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
+    steps:
+      - name: Check out collection
+        if: >-
+          !matrix.skip
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Run nox
+        if: >-
+          !matrix.skip
+        uses: ansible-community/antsibull-nox@main
+        with:
+          extra-python-versions: ${{ matrix.python }}
+          extra-args: ${{ inputs.upload-codecov && '--coverage' || '' }}
+          sessions: ${{ matrix.name }}
+      - name: Upload coverage for final step
+        if: >-
+          !matrix.skip && inputs.upload-codecov
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-sanity-${{ matrix.name }}
+          path: tests/output/reports/coverage=sanity=*.xml
+
+  units:
+    name: ${{ matrix.skip && 'Skipping ' || '' }}Units (${{ matrix.display-name }})
+    needs:
+      - create-matrixes
+    strategy:
+      matrix:
+        include: >-
+          ${{ fromJson(needs.create-matrixes.outputs.units-matrix || '[{"skip": true}]') }}
+    runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
+    steps:
+      - name: Check out collection
+        if: >-
+          !matrix.skip
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Run nox
+        if: >-
+          !matrix.skip
+        uses: ansible-community/antsibull-nox@main
+        with:
+          extra-python-versions: ${{ matrix.python }}
+          extra-args: ${{ inputs.upload-codecov && '--coverage' || '' }}
+          sessions: ${{ matrix.name }}
+      - name: Upload coverage for final step
+        if: >-
+          !matrix.skip && inputs.upload-codecov
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-units-${{ matrix.name }}
+          path: tests/output/reports/coverage=units=*.xml
+
+  integration:
+    name: ${{ matrix.skip && 'Skipping ' || '' }}I (${{ matrix.display-name }})
+    needs:
+      - create-matrixes
+    strategy:
+      fail-fast: false
+      matrix:
+        include: >-
+          ${{ fromJson(needs.create-matrixes.outputs.integration-matrix || '[{"skip": true}]') }}
+    runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
+    steps:
+      - name: Check out collection
+        if: >-
+          !matrix.skip
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Run nox
+        if: >-
+          !matrix.skip
+        uses: ansible-community/antsibull-nox@main
+        with:
+          extra-python-versions: ${{ matrix.python }}
+          extra-args: ${{ inputs.upload-codecov && '--coverage' || '' }}
+          sessions: ${{ matrix.name }}
+      - name: Upload coverage for final step
+        if: >-
+          !matrix.skip && inputs.upload-codecov && (matrix.has-coverage != 'false')
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-integration-${{ matrix.name }}
+          path: tests/output/reports/coverage=integration=*.xml
+
+  upload-coverage:
+    name: Upload coverage
+    if: inputs.upload-codecov
+    needs:
+      - sanity
+      - units
+      - integration
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out collection
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Download coverage from previous steps
+        uses: actions/download-artifact@v4
+        with:
+          pattern: code-coverage-*
+      - name: List all files
+        run: find . -name 'coverage=*.xml'
+        shell: bash
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage=*.xml
+          token: ${{ secrets.CODECOV_TOKEN }}

{antsibull_nox-0.1.0 → antsibull_nox-0.3.0}/.github/workflows/test-gh-action.yml

@@ -2,7 +2,7 @@
 # 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: 2023 Maxwell G <maxwell@gtmx.me
+# SPDX-FileCopyrightText: 2023 Maxwell G <maxwell@gtmx.me>
 
 name: test-gh-action
 'on':
@@ -21,7 +21,7 @@ env:
 jobs:
   test-gh-action:
     runs-on: ubuntu-latest
-    name: "Run nox ${{ matrix.session }} session"
+    name: "Run nox"
     steps:
       - name: Check out antsibull-nox
         uses: actions/checkout@v4

{antsibull_nox-0.1.0 → antsibull_nox-0.3.0}/.pylintrc.automated

@@ -66,7 +66,9 @@ confidence=
 # --disable=W".
 disable=
     locally-disabled,
+    too-few-public-methods,
     too-many-arguments,
+    too-many-lines,
     too-many-locals,
     too-many-positional-arguments,
 

antsibull_nox-0.3.0/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Antsibull Nox Helper Release Notes
+
+**Topics**
+
+- <a href="#v0-3-0">v0\.3\.0</a>
+    - <a href="#release-summary">Release Summary</a>
+    - <a href="#minor-changes">Minor Changes</a>
+    - <a href="#removed-features-previously-deprecated">Removed Features \(previously deprecated\)</a>
+    - <a href="#bugfixes">Bugfixes</a>
+- <a href="#v0-2-0">v0\.2\.0</a>
+    - <a href="#release-summary-1">Release Summary</a>
+    - <a href="#major-changes">Major Changes</a>
+    - <a href="#minor-changes-1">Minor Changes</a>
+    - <a href="#deprecated-features">Deprecated Features</a>
+- <a href="#v0-1-0">v0\.1\.0</a>
+    - <a href="#release-summary-2">Release Summary</a>
+    - <a href="#minor-changes-2">Minor Changes</a>
+    - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
+    - <a href="#bugfixes-1">Bugfixes</a>
+- <a href="#v0-0-1">v0\.0\.1</a>
+    - <a href="#release-summary-3">Release Summary</a>
+
+<a id="v0-3-0"></a>
+## v0\.3\.0
+
+<a id="release-summary"></a>
+### Release Summary
+
+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"></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)\)\.
+* Add <code>callback\_before</code> and <code>callback\_after</code> parameters to <code>antsibull\_nox\.add\_ansible\_test\_session\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/63](https\://github\.com/ansible\-community/antsibull\-nox/pull/63)\)\.
+* Add a <code>antsibull\-nox</code> CLI tool with a subcommand <code>lint\-config</code> that lints <code>noxfile\.py</code> and the <code>antsibull\-nox\.toml</code> config file \([https\://github\.com/ansible\-community/antsibull\-nox/pull/56](https\://github\.com/ansible\-community/antsibull\-nox/pull/56)\)\.
+* Add a session for linting the antsibull\-nox configuration to <code>lint</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/56](https\://github\.com/ansible\-community/antsibull\-nox/pull/56)\)\.
+* Add new options <code>skip\_tests</code>\, <code>allow\_disabled</code>\, and <code>enable\_optional\_errors</code> for ansible\-test sanity sessions \([https\://github\.com/ansible\-community/antsibull\-nox/pull/61](https\://github\.com/ansible\-community/antsibull\-nox/pull/61)\)\.
+* Allow to disable coverage upload for specific integration test jobs in shared workflow with <code>has\-coverage\=false</code> in extra data \([https\://github\.com/ansible\-community/antsibull\-nox/pull/64](https\://github\.com/ansible\-community/antsibull\-nox/pull/64)\)\.
+* Ensure that Galaxy importer\'s output is actually collapsed on GHA \([https\://github\.com/ansible\-community/antsibull\-nox/pull/67](https\://github\.com/ansible\-community/antsibull\-nox/pull/67)\)\.
+* Never show Galaxy importer output unless it can be collapsed\, verbosity is enabled\, or a new config option <code>galaxy\_importer\_always\_show\_logs</code> is set to <code>true</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/67](https\://github\.com/ansible\-community/antsibull\-nox/pull/67)\)\.
+* Skip symlinks that do not point to files in <code>license\-check</code> and <code>yamllint</code> sessions \([https\://github\.com/ansible\-community/antsibull\-nox/pull/61](https\://github\.com/ansible\-community/antsibull\-nox/pull/61)\)\.
+* Update shared workflow to use a <code>display\-name</code> and <code>gha\-container</code> extra data \([https\://github\.com/ansible\-community/antsibull\-nox/pull/63](https\://github\.com/ansible\-community/antsibull\-nox/pull/63)\)\.
+
+<a id="removed-features-previously-deprecated"></a>
+### Removed Features \(previously deprecated\)
+
+* 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"></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)\)\.
+* Do not fail when trying to install an empty list of packages when <code>run\_reuse\=false</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/65](https\://github\.com/ansible\-community/antsibull\-nox/pull/65)\)\.
+* Make sure that <code>extra\_code\_files</code> is considered for <code>black</code> when <code>run\_black\_modules\=false</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/59](https\://github\.com/ansible\-community/antsibull\-nox/pull/59)\)\.
+* Make sure to flush stdout after calling <code>print\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/67](https\://github\.com/ansible\-community/antsibull\-nox/pull/67)\)\.
+
+<a id="v0-2-0"></a>
+## v0\.2\.0
+
+<a id="release-summary-1"></a>
+### Release Summary
+
+Major extension and overhaul with many breaking changes\. The next minor release is expected to bring more stabilization\.
+
+<a id="major-changes"></a>
+### Major Changes
+
+* 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-1"></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)\)\.
+* Add function <code>add\_matrix\_generator</code> which allows to generate matrixes for CI systems for ansible\-test runs \([https\://github\.com/ansible\-community/antsibull\-nox/pull/32](https\://github\.com/ansible\-community/antsibull\-nox/pull/32)\)\.
+* Add several new functions to add ansible\-test runs \([https\://github\.com/ansible\-community/antsibull\-nox/issues/5](https\://github\.com/ansible\-community/antsibull\-nox/issues/5)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/32](https\://github\.com/ansible\-community/antsibull\-nox/pull/32)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/41](https\://github\.com/ansible\-community/antsibull\-nox/pull/41)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/45](https\://github\.com/ansible\-community/antsibull\-nox/pull/45)\)\.
+* Add shared workflow for running ansible\-test from nox and generating the CI matrix from nox as well \([https\://github\.com/ansible\-community/antsibull\-nox/issues/35](https\://github\.com/ansible\-community/antsibull\-nox/issues/35)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/37](https\://github\.com/ansible\-community/antsibull\-nox/pull/37)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/38](https\://github\.com/ansible\-community/antsibull\-nox/pull/38)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/48](https\://github\.com/ansible\-community/antsibull\-nox/pull/48)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/53](https\://github\.com/ansible\-community/antsibull\-nox/pull/53)\)\.
+* Allow to add <code>yamllint</code> session to <code>lint</code> meta\-session that checks YAML files\, and YAML content embedded in plugins and sidecar docs \([https\://github\.com/ansible\-community/antsibull\-nox/pull/42](https\://github\.com/ansible\-community/antsibull\-nox/pull/42)\)\.
+* Allow to add ansible\-lint session \([https\://github\.com/ansible\-community/antsibull\-nox/issues/40](https\://github\.com/ansible\-community/antsibull\-nox/issues/40)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/49](https\://github\.com/ansible\-community/antsibull\-nox/pull/49)\)\.
+* Allow to disable using installed collections that are not checked out next to the current one by setting the environment variable <code>ANTSIBULL\_NOX\_IGNORE\_INSTALLED\_COLLECTIONS</code> to <code>true</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/51](https\://github\.com/ansible\-community/antsibull\-nox/pull/51)\)\.
+* Collapse Galaxy importer\'s output in GitHub Actions \([https\://github\.com/ansible\-community/antsibull\-nox/pull/46](https\://github\.com/ansible\-community/antsibull\-nox/pull/46)\)\.
+* In the GitHub Action\, no longer use installed collections\, but only ones that have been checked out next to the current one\. This avoids using collections that come with the Ansible community package installed in the default GHA image \([https\://github\.com/ansible\-community/antsibull\-nox/pull/51](https\://github\.com/ansible\-community/antsibull\-nox/pull/51)\)\.
+* The action allows to install additional Python versions with the new <code>extra\-python\-versions</code> option \([https\://github\.com/ansible\-community/antsibull\-nox/pull/32](https\://github\.com/ansible\-community/antsibull\-nox/pull/32)\)\.
+* The action allows to pass extra commands after <code>\-\-</code> with the new <code>extra\-args</code> option \([https\://github\.com/ansible\-community/antsibull\-nox/pull/32](https\://github\.com/ansible\-community/antsibull\-nox/pull/32)\)\.
+* antsibull\-nox now automatically installs missing collections\. It uses <code>\.nox/\.cache</code> to store the collection artifacts and the extracted collections \([https\://github\.com/ansible\-community/antsibull\-nox/pull/46](https\://github\.com/ansible\-community/antsibull\-nox/pull/46)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/52](https\://github\.com/ansible\-community/antsibull\-nox/pull/52)\, [https\://github\.com/ansible\-community/antsibull\-nox/issues/7](https\://github\.com/ansible\-community/antsibull\-nox/issues/7)\)\.
+* pydantic is now a required Python dependency of antsibull\-nox \([https\://github\.com/ansible\-community/antsibull\-nox/pull/50](https\://github\.com/ansible\-community/antsibull\-nox/pull/50)\)\.
+* tomli is now a required Python dependency of antsibull\-nox for Python versions 3\.9 and 3\.10 For Python 3\.11\+\, the standard library tomllib will be used \([https\://github\.com/ansible\-community/antsibull\-nox/pull/50](https\://github\.com/ansible\-community/antsibull\-nox/pull/50)\)\.
+
+<a id="deprecated-features"></a>
+### Deprecated Features
+
+* All functions in <code>antsibull\_nox\.\*\*</code> are deprecated except <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code>\, <code>antsibull\_nox\.add\_ansible\_test\_session\(\)</code>\, and <code>antsibull\_nox\.sessions\.prepare\_collections\(\)</code>\. The other function will still work for the next minor release\, but will then be removed\. Use <code>antsibull\-nox\.toml</code> and <code>antsibull\_nox\.load\_antsibull\_nox\_toml\(\)</code> instead \([https\://github\.com/ansible\-community/antsibull\-nox/pull/50](https\://github\.com/ansible\-community/antsibull\-nox/pull/50)\)\.
+
+<a id="v0-1-0"></a>
+## v0\.1\.0
+
+<a id="release-summary-2"></a>
+### Release Summary
+
+Feature release\.
+
+<a id="minor-changes-2"></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)\)\.
+* A <code>docs\-check</code> session that runs <code>antsibull\-docs lint\-collection\-docs</code> can be added with <code>add\_docs\_check\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/issues/8](https\://github\.com/ansible\-community/antsibull\-nox/issues/8)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
+* A <code>extra\-checks</code> session that runs extra checks such as <code>no\-unwanted\-files</code> or <code>action\-groups</code> can be added with <code>add\_extra\_checks\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/issues/8](https\://github\.com/ansible\-community/antsibull\-nox/issues/8)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
+* A <code>license\-check</code> session that runs <code>reuse</code> and checks for bad licenses can be added with <code>add\_license\_check\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/issues/8](https\://github\.com/ansible\-community/antsibull\-nox/issues/8)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
+* Allow to decide which sessions should be marked as default and which not \([https\://github\.com/ansible\-community/antsibull\-nox/issues/18](https\://github\.com/ansible\-community/antsibull\-nox/issues/18)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/20](https\://github\.com/ansible\-community/antsibull\-nox/pull/20)\)\.
+* Allow to provide <code>extra\_code\_files</code> to <code>add\_lint\_sessions\(\)</code> \([https\://github\.com/ansible\-community/antsibull\-nox/pull/14](https\://github\.com/ansible\-community/antsibull\-nox/pull/14)\)\.
+* Check whether we\'re running in CI using the generic <code>\$CI</code> enviornment variable instead of <code>\$GITHUB\_ACTIONS</code>\. <code>\$CI</code> is set to <code>true</code> on Github Actions\, Gitlab CI\, and other CI systems \([https\://github\.com/ansible\-community/antsibull\-nox/pull/28](https\://github\.com/ansible\-community/antsibull\-nox/pull/28)\)\.
+* For running pylint and mypy\, copy the collection and dependent collections into a new tree\. This allows the collection repository to be checked out outside an approriate tree structure\, and it also allows the dependent collections to live in another tree structure\, as long as <code>ansible\-galaxy collection list</code> can find them \([https\://github\.com/ansible\-community/antsibull\-nox/pull/1](https\://github\.com/ansible\-community/antsibull\-nox/pull/1)\)\.
+* When a collection checkout is not part of an <code>ansible\_collections</code> tree\, look for collections in adjacent directories of the form <code>\<namespace\>\.\<name\></code> that match the containing collection\'s FQCN \([https\://github\.com/ansible\-community/antsibull\-nox/issues/6](https\://github\.com/ansible\-community/antsibull\-nox/issues/6)\, [https\://github\.com/ansible\-community/antsibull\-nox/pull/22](https\://github\.com/ansible\-community/antsibull\-nox/pull/22)\)\.
+* antsibull\-nox now depends on antsibull\-fileutils \>\= 1\.2\.0 \([https\://github\.com/ansible\-community/antsibull\-nox/pull/1](https\://github\.com/ansible\-community/antsibull\-nox/pull/1)\)\.
+
+<a id="breaking-changes--porting-guide"></a>
+### Breaking Changes / Porting Guide
+
+* 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-1"></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)\)\.
+
+<a id="v0-0-1"></a>
+## v0\.0\.1
+
+<a id="release-summary-3"></a>
+### Release Summary
+
+Initial alpha release\.

antsibull_nox-0.3.0/CHANGELOG.rst

@@ -0,0 +1,119 @@
+==================================
+Antsibull Nox Helper Release Notes
+==================================
+
+.. contents:: Topics
+
+v0.3.0
+======
+
+Release Summary
+---------------
+
+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.
+
+Minor Changes
+-------------
+
+- Add ``antsibull-nox init`` command that creates a ``noxfile.py`` and ``antsibull-nox.tomll`` to get started (https://github.com/ansible-community/antsibull-nox/pull/58).
+- Add ``callback_before`` and ``callback_after`` parameters to ``antsibull_nox.add_ansible_test_session()`` (https://github.com/ansible-community/antsibull-nox/pull/63).
+- Add a ``antsibull-nox`` CLI tool with a subcommand ``lint-config`` that lints ``noxfile.py`` and the ``antsibull-nox.toml`` config file (https://github.com/ansible-community/antsibull-nox/pull/56).
+- Add a session for linting the antsibull-nox configuration to ``lint`` (https://github.com/ansible-community/antsibull-nox/pull/56).
+- Add new options ``skip_tests``, ``allow_disabled``, and ``enable_optional_errors`` for ansible-test sanity sessions (https://github.com/ansible-community/antsibull-nox/pull/61).
+- Allow to disable coverage upload for specific integration test jobs in shared workflow with ``has-coverage=false`` in extra data (https://github.com/ansible-community/antsibull-nox/pull/64).
+- Ensure that Galaxy importer's output is actually collapsed on GHA (https://github.com/ansible-community/antsibull-nox/pull/67).
+- Never show Galaxy importer output unless it can be collapsed, verbosity is enabled, or a new config option ``galaxy_importer_always_show_logs`` is set to ``true`` (https://github.com/ansible-community/antsibull-nox/pull/67).
+- Skip symlinks that do not point to files in ``license-check`` and ``yamllint`` sessions (https://github.com/ansible-community/antsibull-nox/pull/61).
+- Update shared workflow to use a ``display-name`` and ``gha-container`` extra data (https://github.com/ansible-community/antsibull-nox/pull/63).
+
+Removed Features (previously deprecated)
+----------------------------------------
+
+- Removed all deprecated functions from ``antsibull_nox.**`` that generate sessions. The only functions left that are public API are ``antsibull_nox.load_antsibull_nox_toml()``, ``antsibull_nox.add_ansible_test_session()``, and ``antsibull_nox.sessions.prepare_collections()`` (https://github.com/ansible-community/antsibull-nox/pull/54).
+
+Bugfixes
+--------
+
+- Action groups extra test no longer fails if ``action_groups`` does not exist in ``meta/runtime.yml``. It can now be used to ensure that there is no action group present in ``meta/runtime.yml`` (https://github.com/ansible-community/antsibull-nox/pull/60).
+- Do not fail when trying to install an empty list of packages when ``run_reuse=false`` (https://github.com/ansible-community/antsibull-nox/pull/65).
+- Make sure that ``extra_code_files`` is considered for ``black`` when ``run_black_modules=false`` (https://github.com/ansible-community/antsibull-nox/pull/59).
+- Make sure to flush stdout after calling ``print()`` (https://github.com/ansible-community/antsibull-nox/pull/67).
+
+v0.2.0
+======
+
+Release Summary
+---------------
+
+Major extension and overhaul with many breaking changes. The next minor release is expected to bring more stabilization.
+
+Major Changes
+-------------
+
+- There is now a new function ``antsibull_nox.load_antsibull_nox_toml()`` which loads ``antsibull-nox.toml`` and creates configuration and sessions from it. Calling other functionality from ``antsibull_nox`` in ``noxfile.py`` is only necessary for creating own specialized sessions, or ansible-test sessions that cannot be created with the ``antsibull_nox.add_all_ansible_test_*_test_sessions*()`` type functions (https://github.com/ansible-community/antsibull-nox/pull/50, https://github.com/ansible-community/antsibull-nox/issues/34).
+
+Minor Changes
+-------------
+
+- Add descriptions to generated sessions that are shown when running ``nox --list`` (https://github.com/ansible-community/antsibull-nox/pull/31).
+- Add function ``add_matrix_generator`` which allows to generate matrixes for CI systems for ansible-test runs (https://github.com/ansible-community/antsibull-nox/pull/32).
+- Add several new functions to add ansible-test runs (https://github.com/ansible-community/antsibull-nox/issues/5, https://github.com/ansible-community/antsibull-nox/pull/32, https://github.com/ansible-community/antsibull-nox/pull/41, https://github.com/ansible-community/antsibull-nox/pull/45).
+- Add shared workflow for running ansible-test from nox and generating the CI matrix from nox as well (https://github.com/ansible-community/antsibull-nox/issues/35, https://github.com/ansible-community/antsibull-nox/pull/37, https://github.com/ansible-community/antsibull-nox/pull/38, https://github.com/ansible-community/antsibull-nox/pull/48, https://github.com/ansible-community/antsibull-nox/pull/53).
+- Allow to add ``yamllint`` session to ``lint`` meta-session that checks YAML files, and YAML content embedded in plugins and sidecar docs (https://github.com/ansible-community/antsibull-nox/pull/42).
+- Allow to add ansible-lint session (https://github.com/ansible-community/antsibull-nox/issues/40, https://github.com/ansible-community/antsibull-nox/pull/49).
+- Allow to disable using installed collections that are not checked out next to the current one by setting the environment variable ``ANTSIBULL_NOX_IGNORE_INSTALLED_COLLECTIONS`` to ``true`` (https://github.com/ansible-community/antsibull-nox/pull/51).
+- Collapse Galaxy importer's output in GitHub Actions (https://github.com/ansible-community/antsibull-nox/pull/46).
+- In the GitHub Action, no longer use installed collections, but only ones that have been checked out next to the current one. This avoids using collections that come with the Ansible community package installed in the default GHA image (https://github.com/ansible-community/antsibull-nox/pull/51).
+- The action allows to install additional Python versions with the new ``extra-python-versions`` option (https://github.com/ansible-community/antsibull-nox/pull/32).
+- The action allows to pass extra commands after ``--`` with the new ``extra-args`` option (https://github.com/ansible-community/antsibull-nox/pull/32).
+- antsibull-nox now automatically installs missing collections. It uses ``.nox/.cache`` to store the collection artifacts and the extracted collections (https://github.com/ansible-community/antsibull-nox/pull/46, https://github.com/ansible-community/antsibull-nox/pull/52, https://github.com/ansible-community/antsibull-nox/issues/7).
+- pydantic is now a required Python dependency of antsibull-nox (https://github.com/ansible-community/antsibull-nox/pull/50).
+- tomli is now a required Python dependency of antsibull-nox for Python versions 3.9 and 3.10 For Python 3.11+, the standard library tomllib will be used (https://github.com/ansible-community/antsibull-nox/pull/50).
+
+Deprecated Features
+-------------------
+
+- All functions in ``antsibull_nox.**`` are deprecated except ``antsibull_nox.load_antsibull_nox_toml()``, ``antsibull_nox.add_ansible_test_session()``, and ``antsibull_nox.sessions.prepare_collections()``. The other function will still work for the next minor release, but will then be removed. Use ``antsibull-nox.toml`` and ``antsibull_nox.load_antsibull_nox_toml()`` instead (https://github.com/ansible-community/antsibull-nox/pull/50).
+
+v0.1.0
+======
+
+Release Summary
+---------------
+
+Feature release.
+
+Minor Changes
+-------------
+
+- A ``build-import-check`` session that builds and tries to import the collection with Galaxy Importer can be added with ``add_build_import_check()`` (https://github.com/ansible-community/antsibull-nox/issues/15, https://github.com/ansible-community/antsibull-nox/pull/17).
+- A ``docs-check`` session that runs ``antsibull-docs lint-collection-docs`` can be added with ``add_docs_check()`` (https://github.com/ansible-community/antsibull-nox/issues/8, https://github.com/ansible-community/antsibull-nox/pull/14).
+- A ``extra-checks`` session that runs extra checks such as ``no-unwanted-files`` or ``action-groups`` can be added with ``add_extra_checks()`` (https://github.com/ansible-community/antsibull-nox/issues/8, https://github.com/ansible-community/antsibull-nox/pull/14).
+- A ``license-check`` session that runs ``reuse`` and checks for bad licenses can be added with ``add_license_check()`` (https://github.com/ansible-community/antsibull-nox/issues/8, https://github.com/ansible-community/antsibull-nox/pull/14).
+- Allow to decide which sessions should be marked as default and which not (https://github.com/ansible-community/antsibull-nox/issues/18, https://github.com/ansible-community/antsibull-nox/pull/20).
+- Allow to provide ``extra_code_files`` to ``add_lint_sessions()`` (https://github.com/ansible-community/antsibull-nox/pull/14).
+- Check whether we're running in CI using the generic ``$CI`` enviornment variable instead of ``$GITHUB_ACTIONS``. ``$CI`` is set to ``true`` on Github Actions, Gitlab CI, and other CI systems (https://github.com/ansible-community/antsibull-nox/pull/28).
+- For running pylint and mypy, copy the collection and dependent collections into a new tree. This allows the collection repository to be checked out outside an approriate tree structure, and it also allows the dependent collections to live in another tree structure, as long as ``ansible-galaxy collection list`` can find them (https://github.com/ansible-community/antsibull-nox/pull/1).
+- When a collection checkout is not part of an ``ansible_collections`` tree, look for collections in adjacent directories of the form ``<namespace>.<name>`` that match the containing collection's FQCN (https://github.com/ansible-community/antsibull-nox/issues/6, https://github.com/ansible-community/antsibull-nox/pull/22).
+- antsibull-nox now depends on antsibull-fileutils >= 1.2.0 (https://github.com/ansible-community/antsibull-nox/pull/1).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- The nox workflow now by default runs all sessions, unless restricted with the ``sessions`` parameter (https://github.com/ansible-community/antsibull-nox/pull/14).
+
+Bugfixes
+--------
+
+- Make sure that black in CI checks formatting instead of just reformatting (https://github.com/ansible-community/antsibull-nox/pull/14).
+
+v0.0.1
+======
+
+Release Summary
+---------------
+
+Initial alpha release.

{antsibull_nox-0.1.0 → antsibull_nox-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: antsibull-nox
-Version: 0.1.0
+Version: 0.3.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/
@@ -11,7 +11,7 @@ Author-email: Felix Fontein <felix@fontein.de>, Toshio Kuratomi <a.badger@gmail.
 Maintainer-email: Felix Fontein <felix@fontein.de>, Maxwell G <maxwell@gtmx.me>
 License-Expression: GPL-3.0-or-later
 License-File: LICENSES/GPL-3.0-or-later.txt
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Ansible
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
@@ -25,8 +25,10 @@ Requires-Python: >=3.9.0
 Requires-Dist: antsibull-fileutils<2.0.0,>=1.2.0
 Requires-Dist: nox>=2025.2.9
 Requires-Dist: packaging
+Requires-Dist: pydantic~=2.0
 Requires-Dist: pyyaml
 Requires-Dist: semantic-version
+Requires-Dist: tomli; python_version < '3.11'
 Provides-Extra: codeqa
 Requires-Dist: antsibull-changelog; extra == 'codeqa'
 Requires-Dist: flake8>=3.8.0; extra == 'codeqa'

{antsibull_nox-0.1.0 → antsibull_nox-0.3.0}/action.yml

@@ -14,6 +14,17 @@ inputs:
       Python-version to use. We recommend to stick to the default.
     required: false
     default: "3.13"
+  extra-python-versions:
+    description: |-
+      Newline-separated list of Python versions to install as well.
+      Should be used if other Python versions are needed.
+    required: false
+    default: ""
+  extra-args:
+    description: |-
+      Additional arguments to pass to the nox run after `--`.
+    required: false
+    default: ""
   sessions:
     description: |-
       Nox sessions to run. By default, all sessions are run.
@@ -25,6 +36,10 @@ inputs:
       Should be the directory where the collection's `galaxy.yml` is in, and where the `noxfile.py` is in.
     required: false
     default: .
+outputs:
+  run-nox:
+    description: Output of the 'run nox' step.
+    value: ${{ toJSON(steps.run-nox.outputs) }}
 
 runs:
   using: composite
@@ -33,7 +48,9 @@ runs:
       uses: actions/setup-python@v5
       id: python
       with:
-        python-version: "${{ inputs.python-version }}"
+        python-version: |-
+          ${{ inputs.extra-python-versions }}
+          ${{ inputs.python-version }}
 
     - name: "Install nox and antsibull-nox"
       run: |
@@ -45,7 +62,7 @@ runs:
     - name: "Set up nox environments"
       run: |
         echo "::group::Set up nox environments"
-        nox --verbose --install-only ${{ inputs.sessions && '--sessions' || '' }} ${{ inputs.sessions }}
+        nox --verbose --install-only${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }} 2>&1
         echo "::endgroup::"
       env:
         FORCE_COLOR: "1"
@@ -53,9 +70,11 @@ runs:
       working-directory: "${{ inputs.working-directory }}"
 
     - name: "Run nox"
+      id: run-nox
       run: |
-        nox --verbose --reuse-existing-virtualenvs --no-install ${{ inputs.sessions && '--sessions' || '' }} ${{ inputs.sessions }}
+        nox --verbose --reuse-existing-virtualenvs --no-install${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }}${{ inputs.extra-args && ' -- ' || '' }}${{ inputs.extra-args }} 2>&1
       env:
         FORCE_COLOR: "1"
+        ANTSIBULL_NOX_IGNORE_INSTALLED_COLLECTIONS: "true"
       shell: bash
       working-directory: "${{ inputs.working-directory }}"