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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.flake8 +4 -0
  2. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.github/workflows/reusable-nox-matrix.yml +6 -6
  3. antsibull_nox-0.2.0/docs/changelog.md → antsibull_nox-0.3.0/CHANGELOG.md +64 -6
  4. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/CHANGELOG.rst +38 -0
  5. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/PKG-INFO +2 -2
  6. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/action.yml +2 -2
  7. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/changelogs/changelog.yaml +57 -0
  8. antsibull_nox-0.2.0/CHANGELOG.md → antsibull_nox-0.3.0/docs/changelog.md +43 -20
  9. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/config-file.md +27 -0
  10. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/getting-started.md +4 -2
  11. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/nox-in-ci.md +0 -2
  12. antsibull_nox-0.3.0/docs/reference.md +290 -0
  13. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/pyproject.toml +5 -2
  14. antsibull_nox-0.3.0/src/antsibull_nox/__init__.py +36 -0
  15. antsibull_nox-0.3.0/src/antsibull_nox/_pydantic.py +98 -0
  16. antsibull_nox-0.3.0/src/antsibull_nox/cli.py +132 -0
  17. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/collection/__init__.py +2 -2
  18. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/collection/search.py +8 -4
  19. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/config.py +48 -2
  20. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/action-groups.py +2 -2
  21. antsibull_nox-0.3.0/src/antsibull_nox/data/antsibull-nox-lint-config.py +29 -0
  22. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/license-check.py +5 -1
  23. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/plugin-yamllint.py +3 -0
  24. antsibull_nox-0.3.0/src/antsibull_nox/init.py +83 -0
  25. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/interpret_config.py +17 -8
  26. antsibull_nox-0.3.0/src/antsibull_nox/lint_config.py +113 -0
  27. antsibull_nox-0.3.0/src/antsibull_nox/sessions/__init__.py +70 -0
  28. antsibull_nox-0.3.0/src/antsibull_nox/sessions/ansible_lint.py +58 -0
  29. antsibull_nox-0.3.0/src/antsibull_nox/sessions/ansible_test.py +568 -0
  30. antsibull_nox-0.3.0/src/antsibull_nox/sessions/build_import_check.py +147 -0
  31. antsibull_nox-0.3.0/src/antsibull_nox/sessions/collections.py +137 -0
  32. antsibull_nox-0.3.0/src/antsibull_nox/sessions/docs_check.py +78 -0
  33. antsibull_nox-0.3.0/src/antsibull_nox/sessions/extra_checks.py +127 -0
  34. antsibull_nox-0.3.0/src/antsibull_nox/sessions/license_check.py +73 -0
  35. antsibull_nox-0.3.0/src/antsibull_nox/sessions/lint.py +627 -0
  36. antsibull_nox-0.3.0/src/antsibull_nox/sessions/utils.py +206 -0
  37. antsibull_nox-0.3.0/tests/test-collection/antsibull-nox.toml +8 -0
  38. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/test-collection/galaxy.yml +2 -1
  39. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/test-collection/noxfile.py +1 -8
  40. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/test-collection/plugins/modules/test.py +1 -0
  41. antsibull_nox-0.2.0/docs/reference.md +0 -1049
  42. antsibull_nox-0.2.0/src/antsibull_nox/__init__.py +0 -80
  43. antsibull_nox-0.2.0/src/antsibull_nox/sessions.py +0 -1712
  44. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.github/dependabot.yml +0 -0
  45. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.github/patchback.yml +0 -0
  46. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.github/workflows/nox.yml +0 -0
  47. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.github/workflows/test-gh-action.yml +0 -0
  48. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.gitignore +0 -0
  49. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.pylintrc.automated +0 -0
  50. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/.readthedocs.yml +0 -0
  51. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/CHANGELOG.md.license +0 -0
  52. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/CHANGELOG.rst.license +0 -0
  53. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/LICENSE +0 -0
  54. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/LICENSES/GPL-3.0-or-later.txt +0 -0
  55. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/README.md +0 -0
  56. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/REUSE.toml +0 -0
  57. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/changelogs/changelog.yaml.license +0 -0
  58. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/changelogs/config.yaml +0 -0
  59. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/changelogs/fragments/.keep +0 -0
  60. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/codecov.yml +0 -0
  61. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/changelog.md.license +0 -0
  62. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/community.md +0 -0
  63. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/index.md +0 -0
  64. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/introduction.md +0 -0
  65. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs/troubleshooting.md +0 -0
  66. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/docs-requirements.txt +0 -0
  67. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/mkdocs.yml +0 -0
  68. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/noxfile.py +0 -0
  69. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/ansible.py +0 -0
  70. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/collection/data.py +0 -0
  71. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/collection/extract.py +0 -0
  72. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/collection/install.py +0 -0
  73. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/antsibull_nox_data_util.py +0 -0
  74. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/license-check.py.license +0 -0
  75. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data/no-unwanted-files.py +0 -0
  76. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/data_util.py +0 -0
  77. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/paths.py +0 -0
  78. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/py.typed +0 -0
  79. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/python.py +0 -0
  80. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/src/antsibull_nox/utils.py +0 -0
  81. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/.keep +0 -0
  82. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/needs-network/test_ansible_core.py +0 -0
  83. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/__init__.py +0 -0
  84. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/test_ansible.py +0 -0
  85. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/test_collection.py +0 -0
  86. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/test_python.py +0 -0
  87. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/test_utils.py +0 -0
  88. {antsibull_nox-0.2.0 → antsibull_nox-0.3.0}/tests/unit/utils.py +0 -0
@@ -11,3 +11,7 @@ max-line-length = 100
11
11
  statistics = True
12
12
  # These rules conflict with black
13
13
  ignore = E203, W503
14
+
15
+ # Line in multi-line string is too long:
16
+ per-file-ignores =
17
+ src/antsibull_nox/init.py:E501
@@ -46,7 +46,7 @@ jobs:
46
46
  matrix:
47
47
  include: >-
48
48
  ${{ fromJson(needs.create-matrixes.outputs.sanity-matrix || '[{"skip": true}]') }}
49
- runs-on: ubuntu-latest
49
+ runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
50
50
  steps:
51
51
  - name: Check out collection
52
52
  if: >-
@@ -71,14 +71,14 @@ jobs:
71
71
  path: tests/output/reports/coverage=sanity=*.xml
72
72
 
73
73
  units:
74
- name: ${{ matrix.skip && 'Skipping ' || '' }}Units (Ⓐ${{ matrix.ansible-core }})
74
+ name: ${{ matrix.skip && 'Skipping ' || '' }}Units (${{ matrix.display-name }})
75
75
  needs:
76
76
  - create-matrixes
77
77
  strategy:
78
78
  matrix:
79
79
  include: >-
80
80
  ${{ fromJson(needs.create-matrixes.outputs.units-matrix || '[{"skip": true}]') }}
81
- runs-on: ubuntu-latest
81
+ runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
82
82
  steps:
83
83
  - name: Check out collection
84
84
  if: >-
@@ -103,7 +103,7 @@ jobs:
103
103
  path: tests/output/reports/coverage=units=*.xml
104
104
 
105
105
  integration:
106
- name: ${{ matrix.skip && 'Skipping ' || '' }}I (Ⓐ${{ matrix.ansible-core }}+py${{ matrix.test-python }}+${{ matrix.test-container }})
106
+ name: ${{ matrix.skip && 'Skipping ' || '' }}I (${{ matrix.display-name }})
107
107
  needs:
108
108
  - create-matrixes
109
109
  strategy:
@@ -111,7 +111,7 @@ jobs:
111
111
  matrix:
112
112
  include: >-
113
113
  ${{ fromJson(needs.create-matrixes.outputs.integration-matrix || '[{"skip": true}]') }}
114
- runs-on: ubuntu-latest
114
+ runs-on: ${{ matrix.gha-container || 'ubuntu-latest' }}
115
115
  steps:
116
116
  - name: Check out collection
117
117
  if: >-
@@ -129,7 +129,7 @@ jobs:
129
129
  sessions: ${{ matrix.name }}
130
130
  - name: Upload coverage for final step
131
131
  if: >-
132
- !matrix.skip && inputs.upload-codecov
132
+ !matrix.skip && inputs.upload-codecov && (matrix.has-coverage != 'false')
133
133
  uses: actions/upload-artifact@v4
134
134
  with:
135
135
  name: code-coverage-integration-${{ matrix.name }}
@@ -1,9 +1,67 @@
1
1
  # Antsibull Nox Helper Release Notes
2
2
 
3
+ **Topics**
4
+
5
+ - <a href="#v0-3-0">v0\.3\.0</a>
6
+ - <a href="#release-summary">Release Summary</a>
7
+ - <a href="#minor-changes">Minor Changes</a>
8
+ - <a href="#removed-features-previously-deprecated">Removed Features \(previously deprecated\)</a>
9
+ - <a href="#bugfixes">Bugfixes</a>
10
+ - <a href="#v0-2-0">v0\.2\.0</a>
11
+ - <a href="#release-summary-1">Release Summary</a>
12
+ - <a href="#major-changes">Major Changes</a>
13
+ - <a href="#minor-changes-1">Minor Changes</a>
14
+ - <a href="#deprecated-features">Deprecated Features</a>
15
+ - <a href="#v0-1-0">v0\.1\.0</a>
16
+ - <a href="#release-summary-2">Release Summary</a>
17
+ - <a href="#minor-changes-2">Minor Changes</a>
18
+ - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
19
+ - <a href="#bugfixes-1">Bugfixes</a>
20
+ - <a href="#v0-0-1">v0\.0\.1</a>
21
+ - <a href="#release-summary-3">Release Summary</a>
22
+
23
+ <a id="v0-3-0"></a>
24
+ ## v0\.3\.0
25
+
26
+ <a id="release-summary"></a>
27
+ ### Release Summary
28
+
29
+ Feature release that is stabilizing the API\.
30
+
31
+ All noxfiles and configs using this version should still work with antsibull\-nox 1\.0\.0\,
32
+ unless a critical problem is found that cannot be solved in any other way\.
33
+
34
+ <a id="minor-changes"></a>
35
+ ### Minor Changes
36
+
37
+ * 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)\)\.
38
+ * 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)\)\.
39
+ * 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)\)\.
40
+ * 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)\)\.
41
+ * 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)\)\.
42
+ * 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)\)\.
43
+ * 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)\)\.
44
+ * 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)\)\.
45
+ * 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)\)\.
46
+ * 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)\)\.
47
+
48
+ <a id="removed-features-previously-deprecated"></a>
49
+ ### Removed Features \(previously deprecated\)
50
+
51
+ * 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)\)\.
52
+
53
+ <a id="bugfixes"></a>
54
+ ### Bugfixes
55
+
56
+ * 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)\)\.
57
+ * 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)\)\.
58
+ * 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)\)\.
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)\)\.
60
+
3
61
  <a id="v0-2-0"></a>
4
62
  ## v0\.2\.0
5
63
 
6
- <a id="release-summary"></a>
64
+ <a id="release-summary-1"></a>
7
65
  ### Release Summary
8
66
 
9
67
  Major extension and overhaul with many breaking changes\. The next minor release is expected to bring more stabilization\.
@@ -13,7 +71,7 @@ Major extension and overhaul with many breaking changes\. The next minor release
13
71
 
14
72
  * 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)\)\.
15
73
 
16
- <a id="minor-changes"></a>
74
+ <a id="minor-changes-1"></a>
17
75
  ### Minor Changes
18
76
 
19
77
  * 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)\)\.
@@ -39,12 +97,12 @@ Major extension and overhaul with many breaking changes\. The next minor release
39
97
  <a id="v0-1-0"></a>
40
98
  ## v0\.1\.0
41
99
 
42
- <a id="release-summary-1"></a>
100
+ <a id="release-summary-2"></a>
43
101
  ### Release Summary
44
102
 
45
103
  Feature release\.
46
104
 
47
- <a id="minor-changes-1"></a>
105
+ <a id="minor-changes-2"></a>
48
106
  ### Minor Changes
49
107
 
50
108
  * 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)\)\.
@@ -63,7 +121,7 @@ Feature release\.
63
121
 
64
122
  * 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)\)\.
65
123
 
66
- <a id="bugfixes"></a>
124
+ <a id="bugfixes-1"></a>
67
125
  ### Bugfixes
68
126
 
69
127
  * 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)\)\.
@@ -71,7 +129,7 @@ Feature release\.
71
129
  <a id="v0-0-1"></a>
72
130
  ## v0\.0\.1
73
131
 
74
- <a id="release-summary-2"></a>
132
+ <a id="release-summary-3"></a>
75
133
  ### Release Summary
76
134
 
77
135
  Initial alpha release\.
@@ -4,6 +4,44 @@ Antsibull Nox Helper Release Notes
4
4
 
5
5
  .. contents:: Topics
6
6
 
7
+ v0.3.0
8
+ ======
9
+
10
+ Release Summary
11
+ ---------------
12
+
13
+ Feature release that is stabilizing the API.
14
+
15
+ All noxfiles and configs using this version should still work with antsibull-nox 1.0.0,
16
+ unless a critical problem is found that cannot be solved in any other way.
17
+
18
+ Minor Changes
19
+ -------------
20
+
21
+ - 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).
22
+ - Add ``callback_before`` and ``callback_after`` parameters to ``antsibull_nox.add_ansible_test_session()`` (https://github.com/ansible-community/antsibull-nox/pull/63).
23
+ - 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).
24
+ - Add a session for linting the antsibull-nox configuration to ``lint`` (https://github.com/ansible-community/antsibull-nox/pull/56).
25
+ - 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).
26
+ - 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).
27
+ - Ensure that Galaxy importer's output is actually collapsed on GHA (https://github.com/ansible-community/antsibull-nox/pull/67).
28
+ - 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).
29
+ - Skip symlinks that do not point to files in ``license-check`` and ``yamllint`` sessions (https://github.com/ansible-community/antsibull-nox/pull/61).
30
+ - Update shared workflow to use a ``display-name`` and ``gha-container`` extra data (https://github.com/ansible-community/antsibull-nox/pull/63).
31
+
32
+ Removed Features (previously deprecated)
33
+ ----------------------------------------
34
+
35
+ - 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).
36
+
37
+ Bugfixes
38
+ --------
39
+
40
+ - 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).
41
+ - 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).
42
+ - Make sure that ``extra_code_files`` is considered for ``black`` when ``run_black_modules=false`` (https://github.com/ansible-community/antsibull-nox/pull/59).
43
+ - Make sure to flush stdout after calling ``print()`` (https://github.com/ansible-community/antsibull-nox/pull/67).
44
+
7
45
  v0.2.0
8
46
  ======
9
47
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: antsibull-nox
3
- Version: 0.2.0
3
+ Version: 0.3.0
4
4
  Summary: Changelog tool for Ansible-core and Ansible collections
5
5
  Project-URL: Documentation, https://ansible.readthedocs.io/projects/antsibull-nox/
6
6
  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.
11
11
  Maintainer-email: Felix Fontein <felix@fontein.de>, Maxwell G <maxwell@gtmx.me>
12
12
  License-Expression: GPL-3.0-or-later
13
13
  License-File: LICENSES/GPL-3.0-or-later.txt
14
- Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Development Status :: 4 - Beta
15
15
  Classifier: Framework :: Ansible
16
16
  Classifier: Intended Audience :: Developers
17
17
  Classifier: Programming Language :: Python :: 3
@@ -62,7 +62,7 @@ runs:
62
62
  - name: "Set up nox environments"
63
63
  run: |
64
64
  echo "::group::Set up nox environments"
65
- nox --verbose --install-only${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }}
65
+ nox --verbose --install-only${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }} 2>&1
66
66
  echo "::endgroup::"
67
67
  env:
68
68
  FORCE_COLOR: "1"
@@ -72,7 +72,7 @@ runs:
72
72
  - name: "Run nox"
73
73
  id: run-nox
74
74
  run: |
75
- nox --verbose --reuse-existing-virtualenvs --no-install${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }}${{ inputs.extra-args && ' -- ' || '' }}${{ inputs.extra-args }}
75
+ nox --verbose --reuse-existing-virtualenvs --no-install${{ inputs.sessions && ' --sessions ' || '' }}${{ inputs.sessions }}${{ inputs.extra-args && ' -- ' || '' }}${{ inputs.extra-args }} 2>&1
76
76
  env:
77
77
  FORCE_COLOR: "1"
78
78
  ANTSIBULL_NOX_IGNORE_INSTALLED_COLLECTIONS: "true"
@@ -119,3 +119,60 @@ releases:
119
119
  - 50-config.yml
120
120
  - 51-use-installed.yml
121
121
  release_date: '2025-04-18'
122
+ 0.3.0:
123
+ changes:
124
+ bugfixes:
125
+ - Action groups extra test no longer fails if ``action_groups`` does not exist
126
+ in ``meta/runtime.yml``. It can now be used to ensure that there is no action
127
+ group present in ``meta/runtime.yml`` (https://github.com/ansible-community/antsibull-nox/pull/60).
128
+ - Do not fail when trying to install an empty list of packages when ``run_reuse=false``
129
+ (https://github.com/ansible-community/antsibull-nox/pull/65).
130
+ - Make sure that ``extra_code_files`` is considered for ``black`` when ``run_black_modules=false``
131
+ (https://github.com/ansible-community/antsibull-nox/pull/59).
132
+ - Make sure to flush stdout after calling ``print()`` (https://github.com/ansible-community/antsibull-nox/pull/67).
133
+ minor_changes:
134
+ - Add ``antsibull-nox init`` command that creates a ``noxfile.py`` and ``antsibull-nox.tomll``
135
+ to get started (https://github.com/ansible-community/antsibull-nox/pull/58).
136
+ - Add ``callback_before`` and ``callback_after`` parameters to ``antsibull_nox.add_ansible_test_session()``
137
+ (https://github.com/ansible-community/antsibull-nox/pull/63).
138
+ - Add a ``antsibull-nox`` CLI tool with a subcommand ``lint-config`` that
139
+ lints ``noxfile.py`` and the ``antsibull-nox.toml`` config file (https://github.com/ansible-community/antsibull-nox/pull/56).
140
+ - Add a session for linting the antsibull-nox configuration to ``lint`` (https://github.com/ansible-community/antsibull-nox/pull/56).
141
+ - Add new options ``skip_tests``, ``allow_disabled``, and ``enable_optional_errors``
142
+ for ansible-test sanity sessions (https://github.com/ansible-community/antsibull-nox/pull/61).
143
+ - Allow to disable coverage upload for specific integration test jobs in shared
144
+ workflow with ``has-coverage=false`` in extra data (https://github.com/ansible-community/antsibull-nox/pull/64).
145
+ - Ensure that Galaxy importer's output is actually collapsed on GHA (https://github.com/ansible-community/antsibull-nox/pull/67).
146
+ - Never show Galaxy importer output unless it can be collapsed, verbosity
147
+ is enabled, or a new config option ``galaxy_importer_always_show_logs``
148
+ is set to ``true`` (https://github.com/ansible-community/antsibull-nox/pull/67).
149
+ - Skip symlinks that do not point to files in ``license-check`` and ``yamllint``
150
+ sessions (https://github.com/ansible-community/antsibull-nox/pull/61).
151
+ - Update shared workflow to use a ``display-name`` and ``gha-container`` extra
152
+ data (https://github.com/ansible-community/antsibull-nox/pull/63).
153
+ release_summary: 'Feature release that is stabilizing the API.
154
+
155
+
156
+ All noxfiles and configs using this version should still work with antsibull-nox
157
+ 1.0.0,
158
+
159
+ unless a critical problem is found that cannot be solved in any other way.'
160
+ removed_features:
161
+ - Removed all deprecated functions from ``antsibull_nox.**`` that generate
162
+ sessions. The only functions left that are public API are ``antsibull_nox.load_antsibull_nox_toml()``,
163
+ ``antsibull_nox.add_ansible_test_session()``, and ``antsibull_nox.sessions.prepare_collections()``
164
+ (https://github.com/ansible-community/antsibull-nox/pull/54).
165
+ fragments:
166
+ - 0.3.0.yml
167
+ - 54-remove-explicit.yml
168
+ - 56-config-lint.yml
169
+ - 58-init.yml
170
+ - 59-extra-code-black.yml
171
+ - 60-fixes.yml
172
+ - 61-sanity.yml
173
+ - 62-symlinks.yml
174
+ - 63-workflow.yml
175
+ - 64-workflow.yml
176
+ - 65-fix.yml
177
+ - 67-galaxy-importer.yml
178
+ release_date: '2025-04-21'
@@ -1,24 +1,47 @@
1
1
  # Antsibull Nox Helper Release Notes
2
2
 
3
- **Topics**
4
-
5
- - <a href="#v0-2-0">v0\.2\.0</a>
6
- - <a href="#release-summary">Release Summary</a>
7
- - <a href="#major-changes">Major Changes</a>
8
- - <a href="#minor-changes">Minor Changes</a>
9
- - <a href="#deprecated-features">Deprecated Features</a>
10
- - <a href="#v0-1-0">v0\.1\.0</a>
11
- - <a href="#release-summary-1">Release Summary</a>
12
- - <a href="#minor-changes-1">Minor Changes</a>
13
- - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
14
- - <a href="#bugfixes">Bugfixes</a>
15
- - <a href="#v0-0-1">v0\.0\.1</a>
16
- - <a href="#release-summary-2">Release Summary</a>
3
+ <a id="v0-3-0"></a>
4
+ ## v0\.3\.0
5
+
6
+ <a id="release-summary"></a>
7
+ ### Release Summary
8
+
9
+ Feature release that is stabilizing the API\.
10
+
11
+ All noxfiles and configs using this version should still work with antsibull\-nox 1\.0\.0\,
12
+ unless a critical problem is found that cannot be solved in any other way\.
13
+
14
+ <a id="minor-changes"></a>
15
+ ### Minor Changes
16
+
17
+ * 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)\)\.
18
+ * 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)\)\.
19
+ * 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)\)\.
20
+ * 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)\)\.
21
+ * 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)\)\.
22
+ * 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)\)\.
23
+ * 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)\)\.
24
+ * 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)\)\.
25
+ * 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)\)\.
26
+ * 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)\)\.
27
+
28
+ <a id="removed-features-previously-deprecated"></a>
29
+ ### Removed Features \(previously deprecated\)
30
+
31
+ * 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)\)\.
32
+
33
+ <a id="bugfixes"></a>
34
+ ### Bugfixes
35
+
36
+ * 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)\)\.
37
+ * 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)\)\.
38
+ * 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)\)\.
39
+ * 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)\)\.
17
40
 
18
41
  <a id="v0-2-0"></a>
19
42
  ## v0\.2\.0
20
43
 
21
- <a id="release-summary"></a>
44
+ <a id="release-summary-1"></a>
22
45
  ### Release Summary
23
46
 
24
47
  Major extension and overhaul with many breaking changes\. The next minor release is expected to bring more stabilization\.
@@ -28,7 +51,7 @@ Major extension and overhaul with many breaking changes\. The next minor release
28
51
 
29
52
  * 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)\)\.
30
53
 
31
- <a id="minor-changes"></a>
54
+ <a id="minor-changes-1"></a>
32
55
  ### Minor Changes
33
56
 
34
57
  * 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)\)\.
@@ -54,12 +77,12 @@ Major extension and overhaul with many breaking changes\. The next minor release
54
77
  <a id="v0-1-0"></a>
55
78
  ## v0\.1\.0
56
79
 
57
- <a id="release-summary-1"></a>
80
+ <a id="release-summary-2"></a>
58
81
  ### Release Summary
59
82
 
60
83
  Feature release\.
61
84
 
62
- <a id="minor-changes-1"></a>
85
+ <a id="minor-changes-2"></a>
63
86
  ### Minor Changes
64
87
 
65
88
  * 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)\)\.
@@ -78,7 +101,7 @@ Feature release\.
78
101
 
79
102
  * 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)\)\.
80
103
 
81
- <a id="bugfixes"></a>
104
+ <a id="bugfixes-1"></a>
82
105
  ### Bugfixes
83
106
 
84
107
  * 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)\)\.
@@ -86,7 +109,7 @@ Feature release\.
86
109
  <a id="v0-0-1"></a>
87
110
  ## v0\.0\.1
88
111
 
89
- <a id="release-summary-2"></a>
112
+ <a id="release-summary-3"></a>
90
113
  ### Release Summary
91
114
 
92
115
  Initial alpha release\.
@@ -270,6 +270,11 @@ and there are plenty of configuration settings for the indiviual formatters/lint
270
270
  Allows to specify further packages to install in this session.
271
271
  This can be used for typing stubs like `types-PyYAML`, `types-mock`, and so on.
272
272
 
273
+ ### `antsibull-nox-config` (part of `lint` session)
274
+
275
+ * `run_antsibullnox_config_lint: bool` (default: `true`):
276
+ Lints the antsibull-nox configuration.
277
+
273
278
  ### Example code
274
279
 
275
280
  This example is from `community.dns`,
@@ -548,6 +553,14 @@ It accepts the following options:
548
553
  [Ansible Automation Hub](https://www.redhat.com/en/technologies/management/ansible/automation-hub)
549
554
  is using different settings than [Ansible Galaxy](https://galaxy.ansible.com/), for example.
550
555
 
556
+ * `galaxy_importer_always_show_logs : bool` (default `False`):
557
+ Whether to always show the Galaxy importer logs.
558
+ By default they are only shown when nox is run with verbosity enabled (`-v`)
559
+ or when run in a CI system that supports collapsible groups,
560
+ like GitHub Actions.
561
+
562
+ In the latter case, the output is always shown in a collapsible group.
563
+
551
564
  ### Example code
552
565
 
553
566
  This example is from `community.dns`:
@@ -629,6 +642,20 @@ The function supports the following parameters:
629
642
  The list elements can be strings of the form `"devel"`, `"milestone"`,
630
643
  and `"x.y"` where `x` and `y` are integers that specify a minor ansible-core x.y release.
631
644
 
645
+ * `skip_tests: list[str]` (default `[]`):
646
+ A list of tests to skip.
647
+
648
+ * `allow_disabled: bool` (default `false`):
649
+ Also run tests that are disabled by default.
650
+ Corresponds to `ansible-test sanity`'s `--allow-disabled` option.
651
+ Beware that these tests are disabled by default for a reason.
652
+
653
+ * `enable_optional_errors: bool` (default `false`):
654
+ Enable optional errors.
655
+ Corresponds to `ansible-test sanity`'s `--enable-optional-errors` option.
656
+ Beware that these errors are disabled by default for a reason.
657
+
658
+
632
659
  #### Example code
633
660
 
634
661
  This example is from `community.dns`.
@@ -16,9 +16,11 @@ Before you get started, ensure that you:
16
16
 
17
17
  `antsibull-nox` defines collection tests in a `noxfile.py` file.
18
18
 
19
- 1. Add the following `noxfile.py` file to the root of your collection.
19
+ 1. Run `antsibull-nox init` in the root of your collection.
20
20
  The root is the directory that contains `galaxy.yml`.
21
- 1. Add the following `antsibull-nox.toml` file to the root of your collection.
21
+
22
+ That creates the `noxfile.py` and `antsibull-nox.toml` files shown below.
23
+
22
24
  1. Ensure your `galaxy.yml` file contains values for the `name` and `namespace` fields at a minimum.
23
25
 
24
26
  The **`noxfile.py`** file:
@@ -89,8 +89,6 @@ jobs:
89
89
  ansible-test:
90
90
  uses: ansible-community/antsibull-nox/.github/workflows/reusable-nox-matrix.yml@main
91
91
  with:
92
- collection-namespace: community
93
- collection-name: dns
94
92
  upload-codecov: true
95
93
  secrets:
96
94
  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}