Skip to content

Commit 3036023

Browse files
authored
Document release process (#110)
[reviewed by @jabraham17] Viewed the file as it would appear on the web
2 parents 8f71f30 + c0d2685 commit 3036023

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,41 @@ To install from source on github_::
3131

3232
.. _github: https://github.com/chapel-lang/sphinxcontrib-chapeldomain
3333

34+
Making Changes
35+
--------------
36+
37+
#. Test and commit changes
38+
#. Merge your changes
39+
#. Generate a new PyPI release
40+
41+
Making a Release
42+
----------------
43+
44+
#. Go to main page for repo
45+
#. Click “Releases” on right side of screen
46+
#. Click “Draft a new release” button on top of screen
47+
#. For the tag, make a new tag with the new version number
48+
#. You can generate the release notes via the “generate release notes” button,
49+
comparing against the most recent release. This will autofill in the details
50+
for you
51+
#. Click “Publish release”
52+
- This will trigger the workflow to push a new release to PyPI, assuming no
53+
problems have snuck into our release procedure since the last time it was
54+
run
55+
#. Open a PR bumping the version to the next version number so that we’re ready
56+
for the next change. This should always be the first PR in a new release
57+
(otherwise we’ll have build issues), so it should be straight-forward to
58+
figure out how to do this
59+
60+
In case of issues, the release pushing job is in
61+
.github/workflows/python-publish.yml
62+
63+
You can modify it to try and get things to work. If the issue has something to
64+
do with what was pushed to PyPI, you can adjust it to send to
65+
https://test.pypi.org/ instead and download from there. You’ll want to remove
66+
the bad version from PyPI in that case, which will require access to a user
67+
account associated with the repository on PyPI.
68+
3469
Getting Started
3570
---------------
3671

0 commit comments

Comments
 (0)