Skip to content

Commit 84bbe2e

Browse files
committed
Added some clarification to the release process.
1 parent 952f7ef commit 84bbe2e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README-dev.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,17 @@ tab.
7373
Here are the steps for putting out a fresh release to Pypi.
7474
7575
1. Create a new branch from main and make release specific updates:
76-
* Update `src/psij/version.py` to the new version number
76+
* Update `RELEASE` and `src/psij/version.py` to the new version number
7777
7878
2. Use the standard PR process and get changes from the above step merged to main.
7979
8080
3. Follow instructions here to [pypi docs](https://pypi.org/help/#apitoken) to
8181
setup tokens on your machine.
8282
83-
4. Run `make VERSION="version string" tag-and-release`. This will:
83+
4. Make a clean clone of the main branch
84+
85+
5. Run `make VERSION="version string" tag-and-release`, where the version string
86+
has the format "x.y.z[-s]". This will:
8487
* Create and push tags to GitHub.
8588
* Build the package.
8689
* Push built package to Pypi.

0 commit comments

Comments
 (0)