cb94fd31c8
I was doing final tests on the script today, and forgot to change the hardecoded "pytest-dev/pytest", which ended up publishing a `4.99.10` release to the main repository by mistake, as my token has access to both my fork and main repository. I deleted the tag immeditely just a few seconds later, so hopefully this won't cause major problems. This change makes it safer to test this in the future, never publishing to the main repository by mistake (as long as the tags are pushed to the right repositories of course).
96 lines
2.8 KiB
Python
96 lines
2.8 KiB
Python
"""
|
|
Script used to publish GitHub release notes extracted from CHANGELOG.rst.
|
|
|
|
This script is meant to be executed after a successful deployment in Travis.
|
|
|
|
Uses the following environment variables:
|
|
|
|
* GIT_TAG: the name of the tag of the current commit.
|
|
* GH_RELEASE_NOTES_TOKEN: a personal access token with 'repo' permissions. It should be encrypted using:
|
|
|
|
$travis encrypt GH_RELEASE_NOTES_TOKEN=<token> -r pytest-dev/pytest
|
|
|
|
And the contents pasted in the ``deploy.env.secure`` section in the ``travis.yml`` file.
|
|
|
|
The script also requires ``pandoc`` to be previously installed in the system.
|
|
|
|
Requires Python3.6+.
|
|
"""
|
|
import os
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import github3
|
|
import pypandoc
|
|
|
|
|
|
def publish_github_release(slug, token, tag_name, body):
|
|
github = github3.login(token=token)
|
|
owner, repo = slug.split("/")
|
|
repo = github.repository(owner, repo)
|
|
return repo.create_release(tag_name=tag_name, body=body)
|
|
|
|
|
|
def parse_changelog(tag_name):
|
|
p = Path(__file__).parent.parent / "CHANGELOG.rst"
|
|
changelog_lines = p.read_text(encoding="UTF-8").splitlines()
|
|
|
|
title_regex = re.compile(r"pytest (\d\.\d+\.\d+) \(\d{4}-\d{2}-\d{2}\)")
|
|
consuming_version = False
|
|
version_lines = []
|
|
for line in changelog_lines:
|
|
m = title_regex.match(line)
|
|
if m:
|
|
# found the version we want: start to consume lines until we find the next version title
|
|
if m.group(1) == tag_name:
|
|
consuming_version = True
|
|
# found a new version title while parsing the version we want: break out
|
|
elif consuming_version:
|
|
break
|
|
if consuming_version:
|
|
version_lines.append(line)
|
|
|
|
return "\n".join(version_lines)
|
|
|
|
|
|
def convert_rst_to_md(text):
|
|
return pypandoc.convert_text(text, "md", format="rst")
|
|
|
|
|
|
def main(argv):
|
|
if len(argv) > 1:
|
|
tag_name = argv[1]
|
|
else:
|
|
tag_name = os.environ.get("TRAVIS_TAG")
|
|
if not tag_name:
|
|
print("tag_name not given and $TRAVIS_TAG not set", file=sys.stderr)
|
|
return 1
|
|
|
|
token = os.environ.get("GH_RELEASE_NOTES_TOKEN")
|
|
if not token:
|
|
print("GH_RELEASE_NOTES_TOKEN not set", file=sys.stderr)
|
|
return 1
|
|
|
|
slug = os.environ.get("TRAVIS_REPO_SLUG")
|
|
if not slug:
|
|
print("TRAVIS_REPO_SLUG not set", file=sys.stderr)
|
|
return 1
|
|
|
|
rst_body = parse_changelog(tag_name)
|
|
md_body = convert_rst_to_md(rst_body)
|
|
if not publish_github_release(slug, token, tag_name, md_body):
|
|
print("Could not publish release notes:", file=sys.stderr)
|
|
print(md_body, file=sys.stderr)
|
|
return 5
|
|
|
|
print()
|
|
print(f"Release notes for {tag_name} published successfully:")
|
|
print(f"https://github.com/{slug}/releases/tag/{tag_name}")
|
|
print()
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main(sys.argv))
|