releasing: Add template for major releases (#9596)

* releasing: Add template for major releases

With pytest 6.0.0, we still used a manual releasing workflow (at least if I
remember correctly), and apparently we never wrote a release announcement
template for major releases. Instead, the minor release template claimed that
the release would contain "breaking changes", which doesn't seem reasonable.
Thus, this adds a new major template based on the former minor template, and
adjusts the latter to only mention fixes and new features instead.

* Update scripts/release.minor.rst

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>

Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
This commit is contained in:
Florian Bruhin 2022-02-03 16:33:07 +01:00 committed by GitHub
parent 12b288d84a
commit 2982753d80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 3 deletions

View File

@ -88,7 +88,9 @@ def prepare_release_pr(
print(f"Branch {Fore.CYAN}{release_branch}{Fore.RESET} created.") print(f"Branch {Fore.CYAN}{release_branch}{Fore.RESET} created.")
if prerelease: if is_major:
template_name = "release.major.rst"
elif prerelease:
template_name = "release.pre.rst" template_name = "release.pre.rst"
elif is_feature_release: elif is_feature_release:
template_name = "release.minor.rst" template_name = "release.minor.rst"

24
scripts/release.major.rst Normal file
View File

@ -0,0 +1,24 @@
pytest-{version}
=======================================
The pytest team is proud to announce the {version} release!
This release contains new features, improvements, bug fixes, and breaking changes, so users
are encouraged to take a look at the CHANGELOG carefully:
https://docs.pytest.org/en/stable/changelog.html
For complete documentation, please visit:
https://docs.pytest.org/en/stable/
As usual, you can upgrade from PyPI via:
pip install -U pytest
Thanks to all of the contributors to this release:
{contributors}
Happy testing,
The pytest Development Team

View File

@ -3,8 +3,8 @@ pytest-{version}
The pytest team is proud to announce the {version} release! The pytest team is proud to announce the {version} release!
This release contains new features, improvements, bug fixes, and breaking changes, so users This release contains new features, improvements, and bug fixes,
are encouraged to take a look at the CHANGELOG carefully: the full list of changes is available in the changelog:
https://docs.pytest.org/en/stable/changelog.html https://docs.pytest.org/en/stable/changelog.html