Skip to content

Commit 7fd9894

Browse files
committed
Modifications based on Jade's review
- Separate the release process into a section for making changes and a section for making a release, with an indication in the former that we expect the latter to follow quickly after - reformat the portion about how to handle issues with the release script ---- Signed-off-by: Lydia Duncan <[email protected]>
1 parent 5512101 commit 7fd9894

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,16 @@ To install from source on github_::
3131

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

34-
Release
35-
-------
34+
Making Changes
35+
--------------
3636

3737
#. Test and commit changes
3838
#. Merge your changes
39+
#. Generate a new PyPI release
40+
41+
Making a Release
42+
----------------
43+
3944
#. Go to main page for repo
4045
#. Click “Releases” on right side of screen
4146
#. Click “Draft a new release” button on top of screen
@@ -52,15 +57,16 @@ Release
5257
(otherwise we’ll have build issues), so it should be straight-forward to
5358
figure out how to do this
5459

55-
IF SOMETHING GOES WRONG
60+
.. note::
5661

57-
The release pushing job is in .github/workflows/python-publish.yml
62+
In case of issues, the release pushing job is in
63+
.github/workflows/python-publish.yml
5864

59-
You can modify it to try and get things to work. If the issue has something to
60-
do with what was pushed to PyPI, you can adjust it to send to
61-
https://test.pypi.org/ instead and download from there. You’ll want to remove
62-
the bad version from PyPI in that case, which will require access to a user
63-
account associated with the repository on PyPI.
65+
You can modify it to try and get things to work. If the issue has something
66+
to do with what was pushed to PyPI, you can adjust it to send to
67+
https://test.pypi.org/ instead and download from there. You’ll want to remove
68+
the bad version from PyPI in that case, which will require access to a user
69+
account associated with the repository on PyPI.
6470

6571
Getting Started
6672
---------------

0 commit comments

Comments
 (0)