antsibull-nox 1.4.0

Changelog tool for Ansible-core and Ansible collections

antsibull-nox -- Antsibull Nox Helper

A nox helper for Ansible collections. Please check out the documentation for more information.

antsibull-nox is covered by the Ansible Code of Conduct.

Community

Need help or want to discuss the project? See our Community guide to learn how to join the conversation!

Installation

It can be installed with pip:

pip install antsibull-nox

Versioning and compatibility

From version 1.0.0 on, antsibull-nox sticks to semantic versioning and aims at providing no backwards compatibility breaking changes to the documented API during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.

Interfaces and functions that are not documented in the API reference are exempt from this and might break even in bugfix releases!

Development

Install and run nox to run all tests. That's it for simple contributions! nox will create virtual environments in .nox inside the checked out project and install the requirements needed to run the tests there.

---

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 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

---

To run specific tests:

1. nox -e test to only run unit tests;
2. nox -e lint to run all linters and formatters at once;
3. nox -e formatters to run isort and black;
4. nox -e codeqa to run flake8, pylint, reuse lint, and antsibull-changelog lint;
5. nox -e typing to run mypy.

Creating a new release:

1. Run nox -e bump -- <version> <release_summary_message>. This:
   • Bumps the package version in src/antsibull_nox/__init__.py.
   • Creates changelogs/fragments/<version>.yml with a release_summary section.
   • Runs antsibull-changelog release and adds the changed files to git.
   • Commits with message Release <version>. and runs git tag -a -m 'antsibull-nox <version>' <version>.
   • Runs hatch build --clean.
2. Run git push to the appropriate remotes.
3. Once CI passes on GitHub, run nox -e publish. This:
   • Runs hatch publish;
   • Bumps the version to <version>.post0;
   • Adds the changed file to git and run git commit -m 'Post-release version bump.';
4. Run git push --follow-tags to the appropriate remotes and create a GitHub release.

License

Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later. See LICENSES/GPL-3.0-or-later.txt for a copy of the license.

The repository follows the REUSE Specification for declaring copyright and licensing information.