Skip to content

Commit 92ef6fc

Browse files
committed
Adding release instructions
1 parent 2c39e0a commit 92ef6fc

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README-dev.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,21 @@ where `<port>` is a port number to start the HTTP server on.
5858
When developing the web site, a convenient script is `web/watch.sh`, which can
5959
monitor the source directories and re-build when files are modified. This
6060
requires `inotify` which may or may not be available on your platform.
61+
62+
63+
### Release process
64+
65+
Here are the steps for putting out a fresh release to Pypi.
66+
67+
1. Create a new branch from main, and make release specific updates:
68+
* Update `src/psij/version.py` to the new version number
69+
70+
2. Use the standard PR process and get changes from the above step merged to main.
71+
72+
3. Follow instructions here to [pypi docs](https://pypi.org/help/#apitoken) to
73+
setup tokens on your machine.
74+
75+
4. Run `make VERSION="version string" tag-and-release`. This will:
76+
1. Create and push tags to github
77+
2. Build the package
78+
3. Push built package to Pypi.

0 commit comments

Comments
 (0)