Adds towncrier, a tool for changelog generation

This lets us generate a categorized changelog automagically from
text snippets in the new newsfragments directory. The suffix of
each of these plaintext files determines the category (fix, doc, misc,
etc).

More info at https://towncrier.readthedocs.io
This commit is contained in:
Will Greenberg 2023-10-18 13:22:24 -07:00
parent 5cf5f36f19
commit 07f72b92b4
8 changed files with 28 additions and 27 deletions

View file

@ -2,24 +2,6 @@
Certbot adheres to [Semantic Versioning](https://semver.org/).
## 2.8.0 - master
### Added
*
### Changed
* Support for Python 3.7 was removed.
### Fixed
* `certbot-dns-ovh` plugin now requires `lexicon>=3.15.1` to ensure a consistent behavior with OVH APIs.
* Fixed a bug where argument sources weren't correctly detected in abbreviated
arguments, short arguments, and some other circumstances
More details about these changes can be found on our GitHub repo.
## 2.7.1 - 2023-10-10
### Fixed

1
newsfragments/8272.doc Normal file
View file

@ -0,0 +1 @@
Added towncrier (https://towncrier.readthedocs.io) for automatic changelog generation.

View file

@ -0,0 +1 @@
Drop Python 3.7 support

View file

@ -0,0 +1 @@
Fixed a bug where argument sources weren't correctly detected in abbreviated arguments, short arguments, and some other circumstances

View file

@ -0,0 +1 @@
`certbot-dns-ovh` plugin now requires `lexicon>=3.15.1` to ensure a consistent behavior with OVH APIs.

View file

@ -198,15 +198,7 @@ while ! git commit --gpg-sign="$RELEASE_GPG_KEY" -m "Release $version"; do
done
git tag --local-user "$RELEASE_GPG_KEY" --sign --message "Release $version" "$tag"
# Add master section to CHANGELOG.md
header=$(head -n 4 certbot/CHANGELOG.md)
body=$(sed s/nextversion/$nextversion/ tools/_changelog_top.txt)
footer=$(tail -n +5 certbot/CHANGELOG.md)
echo "$header
$body
$footer" > certbot/CHANGELOG.md
towncrier build
git add certbot/CHANGELOG.md
git commit -m "Add contents to certbot/CHANGELOG.md for next version"

View file

@ -0,0 +1,15 @@
{% if sections[""] %}
{% for category, val in definitions.items() if category in sections[""] %}
### {{ definitions[category]['name'] }}
{% for text, values in sections[""][category].items() %}
- {{ text }} {{ values|join(', ') }}
{% endfor %}
{% endfor %}
{% else %}
No significant changes.
{% endif %}

8
towncrier.toml Normal file
View file

@ -0,0 +1,8 @@
[tool.towncrier]
package = "certbot"
directory = "newsfragments"
filename = "CHANGELOG.md"
template = "tools/changelog_template.jinja"
title_format = "## {version} - {project_date}"
start_string = "Certbot adheres to [Semantic Versioning](https://semver.org/).\n"
issue_format = "[#{issue}](https://github.com/certbot/certbot/issues/{issue})"