diff options
| author |   Tim Harder <radhermit@gmail.com> | 2021-08-05 02:10:53 -0600 |
|---|---|---|
| committer | Tim Harder <radhermit@gmail.com> | 2021-08-05 02:36:04 -0600 |
| commit | d179fcca5c1f13f3e1a391b780a89f0061127ea9 (patch) | |
| tree | e91ce1032ed06812648e7c8ad0762489ad927fe2 /RELEASE.rst | |
| parent | github: various manylinux docker mangling updates (diff) | |
| download | pkgcheck-d179fcca5c1f13f3e1a391b780a89f0061127ea9.tar.gz pkgcheck-d179fcca5c1f13f3e1a391b780a89f0061127ea9.tar.bz2 pkgcheck-d179fcca5c1f13f3e1a391b780a89f0061127ea9.zip | |
add initial release howto doc
Diffstat (limited to 'RELEASE.rst')
| -rw-r--r-- | RELEASE.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/RELEASE.rst b/RELEASE.rst new file mode 100644 index 00000000..cef9b756 --- /dev/null +++ b/RELEASE.rst @@ -0,0 +1,21 @@ +Release process +--------------- + +#. Add new entry in NEWS.rst along with changelog updates for the release. + +#. Make sure dependency versions are correct in requirements/install.txt. + +#. Run a test release build by force pushing to a temporary "deploy" branch. + This triggers the release workflow to run on Github, but doesn't actually + upload any of the generated files to PyPI or Github. + +#. Verify the test build looks correct and passes tests then tag the new + release and push the tag. If everything works as expected, both PyPI and + Github should automatically get the release files pushed to them once the + action completes. + +#. At this point, it's good to remove the temporary deploy branch from the + upstream repo. + +#. Make a commit bumping the package version via __version__ in the base module + and push the commit. |