-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add developer nots with release procedure
- Loading branch information
1 parent
0fbea23
commit a61cccb
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |