Skip to content

Commit

Permalink
docs: add developer nots with release procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
zsquareplusc committed Sep 30, 2021
1 parent 0fbea23 commit a61cccb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions DEVELOPER.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
====================
Notes for developers
====================

Creating a release
==================

- Ensure that the ``version`` in ``serial_asyncio/__init__.py`` is updated
and in the form of major.minor[.patchlevel]
- Ensure all changes, including version, is committed then create a tag with
the exact same value as the version (e.g. "0.5")
- Push to GitHub, merge into master if it is a branch. The GitHub Actions
are set-up to build the default branch.
- Inspect the built wheel and tar.gz files for correctness, test.
- Trigger the upload to PyPi by using GitHub web interface "Releases" and
create a new release from the tag.

0 comments on commit a61cccb

Please sign in to comment.