Skip to content

Commit a61cccb

Browse files
committed
docs: add developer nots with release procedure
1 parent 0fbea23 commit a61cccb

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

DEVELOPER.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
====================
2+
Notes for developers
3+
====================
4+
5+
Creating a release
6+
==================
7+
8+
- Ensure that the ``version`` in ``serial_asyncio/__init__.py`` is updated
9+
and in the form of major.minor[.patchlevel]
10+
- Ensure all changes, including version, is committed then create a tag with
11+
the exact same value as the version (e.g. "0.5")
12+
- Push to GitHub, merge into master if it is a branch. The GitHub Actions
13+
are set-up to build the default branch.
14+
- Inspect the built wheel and tar.gz files for correctness, test.
15+
- Trigger the upload to PyPi by using GitHub web interface "Releases" and
16+
create a new release from the tag.

0 commit comments

Comments
 (0)