Skip to content

Commit 250def7

Browse files
psychedelicioushipsterusername
authored andcommitted
docs: update RELEASE.md troubleshooting info
Add some notes for troubleshooting the release workflow
1 parent b2fb108 commit 250def7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Diff for: docs/RELEASE.md

+19
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,18 @@ Because the installer pulls from PyPI, and we haven't published to PyPI yet, you
7777

7878
> The same wheel file is bundled in the installer and in the `dist` artifact, which is uploaded to PyPI. You should end up with the exactly the same installation as if the installer got the wheel from PyPI.
7979
80+
##### Something isn't right
81+
82+
If testing reveals any issues, no worries. Cancel the workflow, which will cancel the pending publish jobs (you didn't approve them prematurely, right?).
83+
84+
Now you can start from the top:
85+
86+
- Fix the issues and PR the fixes per usual
87+
- Get the PR approved and merged per usual
88+
- Switch to `main` and pull in the fixes
89+
- Run `make tag-release` to move the tag to `HEAD` (which has the fixes) and kick off the release workflow again
90+
- Re-do the sanity check
91+
8092
#### PyPI Publish Jobs
8193

8294
The publish jobs will run if any of the previous jobs fail.
@@ -91,6 +103,12 @@ Both jobs require a maintainer to approve them from the workflow's **Summary** t
91103

92104
> **If the version already exists on PyPI, the publish jobs will fail.** PyPI only allows a given version to be published once - you cannot change it. If version published on PyPI has a problem, you'll need to "fail forward" by bumping the app version and publishing a followup release.
93105
106+
##### Failing PyPI Publish
107+
108+
Check the [python infrastructure status page] for incidents.
109+
110+
If there are no incidents, contact @hipsterusername or @lstein, who have owner access to GH and PyPI, to see if access has expired or something like that.
111+
94112
#### `publish-testpypi` Job
95113

96114
Publishes the distribution on the [Test PyPI] index, using the `testpypi` GitHub environment.
@@ -152,3 +170,4 @@ This functionality is available as a fallback in case something goes wonky. Typi
152170
[trusted publishers]: https://docs.pypi.org/trusted-publishers/
153171
[samuelcolvin/check-python-version]: https://github.com/samuelcolvin/check-python-version
154172
[manually]: #manual-release
173+
[python infrastructure status page]: https://status.python.org/

0 commit comments

Comments
 (0)