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.

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

Release process documented #290

Merged
merged 2 commits into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ nav:
- Overview of Chaining Rules: chaining_rules.md
- A basic guide for the SSSOM toolkit: toolkit.md
- 5-Star Entity Mappings - Cheatsheet: 5star-mappings.md
- Update schema/context and release: update.md

site_url: https://mapping-commons.github.io/sssom/
repo_url: https://github.com/mapping-commons/sssom/
Expand Down
10 changes: 10 additions & 0 deletions src/docs/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Final process

1. Finish your edits and merge them into master
2. Rebuild the LinkML model using the [“build” action](https://github.com/mapping-commons/sssom/blob/master/.github/workflows/build.yml)
3. Create a [GitHub release](https://github.com/mapping-commons/sssom/releases)
- This will automatically trigger a PyPI release using [this action](https://github.com/mapping-commons/sssom/blob/master/.github/workflows/pypi-publish.yaml), of the sssom_schema module
- The context file is packaged and delivered to projects that depend on `sssom-schema`.
4. Updating sssom-py
1. After the pypi release is completed, update sssom-schema dependency using `poetry update sssom-schema`. The new context is available and accessible via `pkg_resources`.
1. Release `sssom-py` using the same method as `sssom-schema` above.