Follow this document to make new Phenopacket store release.
-
Start on
main
branch -
Ensure
main
branch is clean with no uncommitted changes -
Update
src/ppktstore/__init__.py
to setppktstore.__version__
to the desired version (e.g.0.1.16
) -
Commit the change (e.g. with a commit message "Release 0.1.16")
-
If required, update the local installation to make sure we get the latest version
python3 -m pip install -e .
-
Generate release archives with
ppktstore
CLI:python3 -m ppktstore package --notebook-dir notebooks --format zip --output all_phenopackets
This will generate
all_phenopackets.zip
archive file in the current directory -
Run the
PhenopacketStoreStats
notebook to update the stats -
Commit the changes in the notebook
-
Push the commits to GitHub
-
Go to Releases and click on Draft a new release button to start making a new release
-
Click on Choose a tag dropdown, type the release in (e.g.
0.1.16
), and click on Create new tag on publish (IMPORTANT!) -
Click on Generate release notes button to add what's changed into the release notes
-
Attach the release archive generated in the 6th step by dragging it into the area located below the release notes
-
Click Publish release to make the release
-
IMPORTANT! bump
ppktstore.__version__
(e.g.0.1.17-dev0
), commit the change, and push the commit to GitHub to start the next development iteration
Done!