Skip to content

Commit b2fb108

Browse files
psychedelicioushipsterusername
authored andcommitted
docs: update RELEASE.md publish GH release section
Clarify steps & mention the `get_external_contributions.py` script
1 parent 383f890 commit b2fb108

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/RELEASE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,13 @@ Publishes the distribution on the production PyPI index, using the `pypi` GitHub
120120
Once the release is published to PyPI, it's time to publish the GitHub release.
121121

122122
1. [Draft a new release] on GitHub, choosing the tag that triggered the release.
123-
2. Write the release notes, describing important changes. The **Generate release notes** button automatically inserts the changelog and new contributors, and you can copy/paste the intro from previous releases.
124-
3. Upload the zip file created in **`build`** job into the Assets section of the release notes. You can also upload the zip into the body of the release notes, since it can be hard for users to find the Assets section.
125-
4. Check the **Set as a pre-release** and **Create a discussion for this release** checkboxes at the bottom of the release page.
126-
5. Publish the pre-release.
127-
6. Announce the pre-release in Discord.
123+
1. Write the release notes, describing important changes. The **Generate release notes** button automatically inserts the changelog and new contributors, and you can copy/paste the intro from previous releases.
124+
1. Use `scripts/get_external_contributions.py` to get a list of external contributions to shout out in the release notes.
125+
1. Upload the zip file created in **`build`** job into the Assets section of the release notes.
126+
1. Check **Set as a pre-release** if it's a pre-release.
127+
1. Check **Create a discussion for this release**.
128+
1. Publish the release.
129+
1. Announce the release in Discord.
128130

129131
> **TODO** Workflows can create a GitHub release from a template and upload release assets. One popular action to handle this is [ncipollo/release-action]. A future enhancement to the release process could set this up.
130132

0 commit comments

Comments
 (0)