p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

scripts: Use release branch for changelog URL (#9380) 

* scripts: Use release branch for changelog URL

With a prerelease, /stable won't show the correct changelog.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Florian Bruhin 2021-12-07 11:24:57 +01:00 committed by GitHub
parent 5cb50fa13c
commit 21a186bbda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
scripts/prepare-release-pr.py
View File

@ -90,10 +90,13 @@ def prepare_release_pr(
if prerelease: if prerelease:
template_name = "release.pre.rst" template_name = "release.pre.rst"
doc_version = release_branch
elif is_feature_release: elif is_feature_release:
template_name = "release.minor.rst" template_name = "release.minor.rst"
doc_version = "" # unused in template
else: else:
template_name = "release.patch.rst" template_name = "release.patch.rst"
doc_version = "" # unused in template
# important to use tox here because we have changed branches, so dependencies # important to use tox here because we have changed branches, so dependencies
# might have changed as well # might have changed as well
@ -104,6 +107,7 @@ def prepare_release_pr(
"--", "--",
version, version,
template_name, template_name,
doc_version,
"--skip-check-links", "--skip-check-links",
] ]
print("Running", " ".join(cmdline)) print("Running", " ".join(cmdline))

2
scripts/release.pre.rst
View File

@ -19,7 +19,7 @@ You can upgrade from PyPI via:
Users are encouraged to take a look at the CHANGELOG carefully: Users are encouraged to take a look at the CHANGELOG carefully:
https://docs.pytest.org/en/stable/changelog.html https://docs.pytest.org/en/{doc_version}/changelog.html
Thanks to all the contributors to this release: Thanks to all the contributors to this release:

14
scripts/release.py
View File

@ -10,7 +10,7 @@ from colorama import Fore
from colorama import init from colorama import init
def announce(version, template_name): def announce(version, template_name, doc_version):
"""Generates a new release announcement entry in the docs.""" """Generates a new release announcement entry in the docs."""
# Get our list of authors # Get our list of authors
stdout = check_output(["git", "describe", "--abbrev=0", "--tags"]) stdout = check_output(["git", "describe", "--abbrev=0", "--tags"])
@ -31,7 +31,9 @@ def announce(version, template_name):
) )
contributors_text = "\n".join(f"* {name}" for name in sorted(contributors)) + "\n" contributors_text = "\n".join(f"* {name}" for name in sorted(contributors)) + "\n"
text = template_text.format(version=version, contributors=contributors_text) text = template_text.format(
version=version, contributors=contributors_text, doc_version=doc_version
)
target = Path(__file__).parent.joinpath(f"../doc/en/announce/release-{version}.rst") target = Path(__file__).parent.joinpath(f"../doc/en/announce/release-{version}.rst")
target.write_text(text, encoding="UTF-8") target.write_text(text, encoding="UTF-8")
@ -82,9 +84,9 @@ def check_links():
check_call(["tox", "-e", "docs-checklinks"]) check_call(["tox", "-e", "docs-checklinks"])
def pre_release(version, template_name, *, skip_check_links): def pre_release(version, template_name, doc_version, *, skip_check_links):
"""Generates new docs, release announcements and creates a local tag.""" """Generates new docs, release announcements and creates a local tag."""
announce(version, template_name) announce(version, template_name, doc_version)
regen(version) regen(version)
changelog(version, write_out=True) changelog(version, write_out=True)
fix_formatting() fix_formatting()
@ -112,11 +114,15 @@ def main():
parser.add_argument( parser.add_argument(
"template_name", help="Name of template file to use for release announcement" "template_name", help="Name of template file to use for release announcement"
) )
parser.add_argument(
"doc_version", help="For prereleases, the version to link to in the docs"
)
parser.add_argument("--skip-check-links", action="store_true", default=False) parser.add_argument("--skip-check-links", action="store_true", default=False)
options = parser.parse_args() options = parser.parse_args()
pre_release( pre_release(
options.version, options.version,
options.template_name, options.template_name,
options.doc_version,
skip_check_links=options.skip_check_links, skip_check_links=options.skip_check_links,
) )