Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include running stats notebook into release #139

Merged
merged 3 commits into from
Aug 5, 2024
Merged

Include running stats notebook into release #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af2b928
Include running stats notebook into release.
ielis Aug 5, 2024
d4c6b49
Merge branch 'main' into include-stats-into-release-checklist
ielis Aug 5, 2024
eccd061
Update notebook.
ielis Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions HOW_TO_RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,21 @@ Follow this document to make new Phenopacket store release.
2. Ensure `main` branch is clean with no uncommitted changes
3. Update `src/ppktstore/__init__.py` to set `ppktstore.__version__` to the desired version (e.g. `0.1.16`)
4. Commit the change (e.g. with a commit message "Release 0.1.16")
5. Push the commit to GitHub
6. Generate release archives with `ppktstore` CLI:
5. Generate release archives with `ppktstore` CLI:
```shell
python3 -m ppktstore package --notebook-dir notebooks --format zip --output all_phenopackets
```

This will generate `all_phenopackets.zip` archive file in the current directory

7. Go to [Releases](https://github.com/monarch-initiative/phenopacket-store/releases) and click on *Draft a new release* button to start making a new release
8. Click on *Choose a tag* dropdown, type the release in (e.g. `0.1.16`), and click on *Create new tag on publish* (**IMPORTANT!**)
6. Run the `PhenopacketStoreStats` notebook to update the stats
7. Commit the changes in the notebook
8. Push the commits to GitHub
9. Go to [Releases](https://github.com/monarch-initiative/phenopacket-store/releases) and click on *Draft a new release* button to start making a new release
10. Click on *Choose a tag* dropdown, type the release in (e.g. `0.1.16`), and click on *Create new tag on publish* (**IMPORTANT!**)
![Choose a tag](img/choose_a_tag.png)
9. Click on *Generate release notes* button to add what's changed into the release notes
10. Attach the release archive generated in the 6th step by dragging it into the area located below the release notes
11. Click *Publish release* to make the release
12. **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
11. Click on *Generate release notes* button to add what's changed into the release notes
12. Attach the release archive generated in the 6th step by dragging it into the area located below the release notes
13. Click *Publish release* to make the release
14. **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!
Loading
Loading