Skip to content

Commit 1b993f2

Browse files
committed
add initial release guide
1 parent d5b71cf commit 1b993f2

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

RELEASE.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Release process
2+
---------------
3+
4+
#. Add new entry in NEWS.rst along with changelog updates for the release.
5+
6+
#. Make sure dependency versions are correct in requirements/install.txt.
7+
8+
#. Run a test release build by force pushing to a temporary "deploy" branch.
9+
This triggers the release workflow to run on Github, but doesn't actually
10+
upload any of the generated files to PyPI or Github.
11+
12+
#. Verify the test build looks correct and passes tests then tag the new
13+
release and push the tag. If everything works as expected, both PyPI and
14+
Github should automatically get the release files pushed to them once the
15+
action completes.
16+
17+
#. At this point, it's good to remove the temporary deploy branch from the
18+
upstream repo.
19+
20+
#. Make a commit bumping the package version via __version__ in the base module
21+
and push the commit.

0 commit comments

Comments
 (0)