Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,41 @@ To install from source on github_::

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

Making Changes
--------------

#. Test and commit changes
#. Merge your changes
#. Generate a new PyPI release

Making a Release
----------------

#. Go to main page for repo
#. Click “Releases” on right side of screen
#. Click “Draft a new release” button on top of screen
#. For the tag, make a new tag with the new version number
#. You can generate the release notes via the “generate release notes” button,
comparing against the most recent release. This will autofill in the details
for you
#. Click “Publish release”
- This will trigger the workflow to push a new release to PyPI, assuming no
problems have snuck into our release procedure since the last time it was
run
#. Open a PR bumping the version to the next version number so that we’re ready
for the next change. This should always be the first PR in a new release
(otherwise we’ll have build issues), so it should be straight-forward to
figure out how to do this

In case of issues, the release pushing job is in
.github/workflows/python-publish.yml

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

Getting Started
---------------

Expand Down