Skip to content

Commit 2982753

Browse files
The-Compilernicoddemus
andauthoredFeb 3, 2022
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 <[email protected]> Co-authored-by: Bruno Oliveira <[email protected]>
1 parent 12b288d commit 2982753

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed
 

‎scripts/prepare-release-pr.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ def prepare_release_pr(
8888

8989
print(f"Branch {Fore.CYAN}{release_branch}{Fore.RESET} created.")
9090

91-
if prerelease:
91+
if is_major:
92+
template_name = "release.major.rst"
93+
elif prerelease:
9294
template_name = "release.pre.rst"
9395
elif is_feature_release:
9496
template_name = "release.minor.rst"

‎scripts/release.major.rst

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
pytest-{version}
2+
=======================================
3+
4+
The pytest team is proud to announce the {version} release!
5+
6+
This release contains new features, improvements, bug fixes, and breaking changes, so users
7+
are encouraged to take a look at the CHANGELOG carefully:
8+
9+
https://docs.pytest.org/en/stable/changelog.html
10+
11+
For complete documentation, please visit:
12+
13+
https://docs.pytest.org/en/stable/
14+
15+
As usual, you can upgrade from PyPI via:
16+
17+
pip install -U pytest
18+
19+
Thanks to all of the contributors to this release:
20+
21+
{contributors}
22+
23+
Happy testing,
24+
The pytest Development Team

‎scripts/release.minor.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ pytest-{version}
33

44
The pytest team is proud to announce the {version} release!
55

6-
This release contains new features, improvements, bug fixes, and breaking changes, so users
7-
are encouraged to take a look at the CHANGELOG carefully:
6+
This release contains new features, improvements, and bug fixes,
7+
the full list of changes is available in the changelog:
88

99
https://docs.pytest.org/en/stable/changelog.html
1010

0 commit comments

Comments
 (0)
Please sign in to comment.