Skip to main content

Antsibull docutils helpers

Project description

antsibull-docutils -- Antsibull docutils helpers

Discuss on Matrix at #antsibull:ansible.com Nox badge Codecov badge REUSE status

A Python library with some docutils helpers used by Antsibull tools.

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

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.

To run specific tests:

  1. nox -e test to only run unit tests;
  2. nox -e coverage to display combined coverage results after running nox -e test integration;
  3. nox -e lint to run all linters and formatters at once;
  4. nox -e formatters to run isort and black;
  5. nox -e codeqa to run flake8, pylint, reuse lint, and antsibull-changelog lint;
  6. 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_docutils/__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-docutils <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. The only exception are changelog fragments in changelog/fragments/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

antsibull_docutils-1.0.0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

antsibull_docutils-1.0.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file antsibull_docutils-1.0.0.tar.gz.

File metadata

  • Download URL: antsibull_docutils-1.0.0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for antsibull_docutils-1.0.0.tar.gz
Algorithm Hash digest
SHA256 078f7110e85d8df235c14a2db1a19e434bb77eaa059877dde85a70426996f960
MD5 7a85381b4a3ff6a20de13a8d0d195171
BLAKE2b-256 c9a23b3de171b0b9518bdf7c97edbbf618a5f0b7c1a06904222e590551eec6bf

See more details on using hashes here.

File details

Details for the file antsibull_docutils-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for antsibull_docutils-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a2f0f10f53b1f35f9d08a05267a827133ed5c544cc6a1f63feba26581967fb62
MD5 37b8cf9154002a5126fd0031e6a607a9
BLAKE2b-256 b6673f10b89eb8cfda0d5da6ae123b752a0c8f1f4474ba907f87b33e7b19df2e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page