Package: antsibull-core
antsibull-core -- Library for Ansible Build ScriptsLibrary needed for tooling for building various things related to Ansible.You can find a list of changes inthe antsibull-core changelog.Unless otherwise noted in the code, it is licensed under the terms of the GNU
General Public License v3 or, at your option, later.antsibull-core is covered by theAnsible Code of Conduct.Versioning and compatibilityFrom version 1.0.0 on, antsibull-core sticks to semantic versioning and aims at providing no backwards compatibility breaking changes during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.The current major version is 2.x.y. Development for 2.x.y occurs on themainbranch. 1.x.y is End of Life and was developed on thestable-1branch. It is no longer updated. 2.x.y mainly differs from 1.x.y by dropping support for Python 3.6, 3.7, and 3.8. It deprecates several compatibility functions for older Python versions that are no longer needed; see the changelog for details.DevelopmentInstall and runnoxto run all tests. That's it for simple contributions!noxwill create virtual environments in.noxinside the checked out project
and install the requirements needed to run the tests there.To run specific tests:nox -e testto only run unit tests;nox -e coverageto display combined coverage results after runningnox -e test;nox -e lintto run all linters and formatters at once;nox -e formattersto runisortandblack;nox -e codeqato runflake8,pylint,reuse lint, andantsibull-changelog lint;nox -e typingto runmypyandpyreCreating a new release:Runnox -e bump -- <version> <release_summary_message>. This:Bumps the package version inpyproject.toml.Createschangelogs/fragments/<version>.ymlwith arelease_summarysection.Runsantsibull-changelog releaseand adds the changed files to git.Commits with messageRelease <version>.and runsgit tag -a -m 'antsibull-core <version>' <version>.Runshatch build.Rungit pushto the appropriate remotes.Once CI passes on GitHub, runnox -e publish. This:Runshatch publish;Bumps the version to<version>.post0;Adds the changed file to git and rungit commit -m 'Post-release version bump.';Rungit push --follow-tagsto the appropriate remotes and create a GitHub release.LicenseUnless otherwise noted in the code, it is licensed under the terms of the GNU
General Public License v3 or, at your option, later. SeeLICENSES/GPL-3.0-or-later.txtfor a copy of the license.Parts of the code are vendored from other sources and are licensed under other licenses:src/antsibull_core/vendored/collections.pyandsrc/antsibull_core/vendored/json_utils.pyare licensed under the terms of the BSD 2-Clause license. SeeLICENSES/BSD-2-Clause.txtfor a copy of the license.tests/functional/aiohttp_utils.pyandtests/functional/certificate_utils.pyare licensed under the terms of the MIT license. SeeLICENSES/MIT.txtfor a copy of the license.src/antsibull_core/vendored/_argparse_booleanoptionalaction.pyis licensed under the terms of the Python Software Foundation license version 2. SeeLICENSES/PSF-2.0.txtfor a copy of the license.The repository follows theREUSE Specificationfor declaring copyright and
licensing information. The only exception are changelog fragments inchangelog/fragments/.