Skip to content

Commit 89528f3

Browse files
committed
build: releases get a nicer pypi/install footer
1 parent 5e8d0c9 commit 89528f3

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

ci/github_releases.py

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,11 @@ def get_releases(session, repo):
7474
releases = { r['tag_name']: r for r in github_paginated(session, url) }
7575
return releases
7676

77-
RELEASE_BODY_FMT = """
77+
RELEASE_BODY_FMT = """\
7878
{relnote_text}
7979
80-
---
81-
PyPI page: [coverage {version}](https://pypi.org/project/coverage/{version})
82-
83-
To install:
84-
```
85-
$ python3 -m pip install coverage=={version}
86-
```
80+
:arrow_right:\xa0 PyPI page: [coverage {version}](https://pypi.org/project/coverage/{version}).
81+
:arrow_right:\xa0 To install: `python3 -m pip install coverage=={version}`
8782
"""
8883

8984
def release_for_relnote(relnote):
@@ -101,22 +96,20 @@ def release_for_relnote(relnote):
10196
"prerelease": relnote["prerelease"],
10297
}
10398

104-
def create_release(session, repo, relnote):
99+
def create_release(session, repo, release_data):
105100
"""
106101
Create a new GitHub release.
107102
"""
108-
print(f"Creating {relnote['version']}")
109-
data = release_for_relnote(relnote)
110-
resp = session.post(RELEASES_URL.format(repo=repo), json=data)
103+
print(f"Creating {release_data['name']}")
104+
resp = session.post(RELEASES_URL.format(repo=repo), json=release_data)
111105
check_ok(resp)
112106

113-
def update_release(session, url, relnote):
107+
def update_release(session, url, release_data):
114108
"""
115109
Update an existing GitHub release.
116110
"""
117-
print(f"Updating {relnote['version']}")
118-
data = release_for_relnote(relnote)
119-
resp = session.patch(url, json=data)
111+
print(f"Updating {release_data['name']}")
112+
resp = session.patch(url, json=release_data)
120113
check_ok(resp)
121114

122115
def update_github_releases(json_filename, repo):
@@ -139,14 +132,15 @@ def update_github_releases(json_filename, repo):
139132
tag = relnote["version"]
140133
if not does_tag_exist(tag):
141134
continue
135+
release_data = release_for_relnote(relnote)
142136
exists = tag in releases
143137
if not exists:
144-
create_release(gh_session, repo, relnote)
138+
create_release(gh_session, repo, release_data)
145139
else:
146140
release = releases[tag]
147-
if release["body"] != relnote["text"]:
141+
if release["body"] != release_data["body"]:
148142
url = release["url"]
149-
update_release(gh_session, url, relnote)
143+
update_release(gh_session, url, release_data)
150144

151145
if __name__ == "__main__":
152146
update_github_releases(*sys.argv[1:3])

0 commit comments

Comments
 (0)