Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ansible-community/antsibull-changelog
Changelog generator for ansible, ansible-base, and collections.
https://github.com/ansible-community/antsibull-changelog
ansible changelog-generator collections python
Last synced: 1 day ago
JSON representation
Changelog generator for ansible, ansible-base, and collections.
- Host: GitHub
- URL: https://github.com/ansible-community/antsibull-changelog
- Owner: ansible-community
- License: gpl-3.0
- Created: 2020-05-29T17:40:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T08:15:50.000Z (3 months ago)
- Last Synced: 2024-10-29T20:00:37.523Z (3 months ago)
- Topics: ansible, changelog-generator, collections, python
- Language: Python
- Homepage: https://ansible.readthedocs.io/projects/antsibull-changelog/
- Size: 683 KB
- Stars: 38
- Watchers: 9
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# antsibull-changelog -- Ansible Changelog Tool
[](https://matrix.to/#/#antsibull:ansible.com)
[](https://github.com/ansible-community/antsibull-changelog/actions?query=workflow%3A%22nox%22+branch%3Amain)
[](https://codecov.io/gh/ansible-community/antsibull-changelog)
[](https://api.reuse.software/info/github.com/ansible-community/antsibull-changelog)
A changelog generator used by ansible-core and Ansible collections.
- Using the
[`antsibull-changelog` CLI tool for collections](https://github.com/ansible-community/antsibull-changelog/tree/main/docs/changelogs.md).
- Using the
[`antsibull-changelog` CLI tool for other projects](https://github.com/ansible-community/antsibull-changelog/tree/main/docs/other-projects.md).
- Documentation on the [`changelogs/config.yaml` configuration file for `antsibull-changelog`](https://github.com/ansible-community/antsibull-changelog/tree/main/docs/changelog-configuration.md).
- Documentation on the
[`changelog.yaml` format](https://github.com/ansible-community/antsibull-changelog/tree/main/docs/changelog.yaml-format.md).
antsibull-changelog is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
## Community
Need help or want to discuss the project? See our [Community guide](https://ansible.readthedocs.io/projects/antsibull-changelog/community/) to learn how to join the conversation!
## Installation
It can be installed with pip:
pip install antsibull-changelog
For python projects, `antsibull-changelog release` can retrieve the current
version from `pyproject.toml`.
You can install the project with
pip install antsibull-changelog[toml]
to pull in the necessary toml parser for this feature.
The `toml` extra is always available, but it is noop on Python >= 3.11,
as `tomllib` is part of the standard library.
For more information, see the [documentation](https://ansible.readthedocs.io/projects/antsibull-changelog/).
## 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-changelog depends on the sister antsibull-docutils and antsibull-fileutils projects.
By default, `nox` will install a development version of these projects from Github.
If you're hacking on antsibull-docutils and/or antsibull-fileutils alongside antsibull-changelog,
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 those paths don'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 integration` to only run integration tests; this runs
`antsibull-changelog lint` against antsibull-changelog and community.general
(after cloning its repository) and records coverage data.
3. `nox -e coverage` to display combined coverage results after running `nox -e
test integration`;
4. `nox -e lint` to run all linters and formatters at once;
5. `nox -e formatters` to run `isort` and `black`;
3. `nox -e codeqa` to run `flake8`, `pylint`, `reuse lint`, and `antsibull-changelog lint`;
7. `nox -e typing` to run `mypy`.
## Creating a new release:
1. Run `nox -e bump -- `. This:
* Bumps the package version in `src/antsibull_changelog/__init__.py`.
* Creates `changelogs/fragments/.yml` with a `release_summary` section.
* Runs `antsibull-changelog release` and adds the changed files to git.
* Commits with message `Release .` and runs `git tag -a -m 'antsibull-changelog ' `.
* 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 `.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](https://github.com/ansible-community/antsibull-changelog/tree/main/LICENSE)
for a copy of the license.
The repository follows the [REUSE Specification](https://reuse.software/spec/) for declaring copyright and
licensing information. The only exception are changelog fragments in ``changelog/fragments/``.