Skip to content

Commit c766f58

Browse files
committed
Add release guidelines
1 parent 7e406c0 commit c766f58

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

RELEASING.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Releasing
2+
=========
3+
4+
1. Merge all intended and verified pull requests into the ``master`` branch.
5+
2. Create a local build and test:
6+
- Run ``python -m build`` to create a source distribution and a wheel.
7+
- Install both artifacts in a fresh virtual environment to ensure they work correctly.
8+
3. Bump the version number in ``setup.py``. (May be included in the pull request.)
9+
4. Update the changelog in ``CHANGES.rst``.
10+
5. Update the release date in ``CHANGES.rst``.
11+
6. Ensure the latest build passes on GitHub Actions.
12+
7. Rebuild the documentation and check that it looks correct.
13+
8. Create a new release on GitHub:
14+
- Use the version number as the tag.
15+
- Include the changelog in the release notes.
16+
9. Ensure the release is published.
17+
10. Test the release by installing it in a fresh virtual environment.

0 commit comments

Comments
 (0)