-
Notifications
You must be signed in to change notification settings - Fork 24
Closed
Description
Summary
This issue tracks the development of a GitHub Actions workflow to automate the MIxS release process. The goal is to make it simple for authorized GSC members to trigger releases without deep technical expertise.
Development is happening in: turbomam#106
Once tested and proven in the fork, a PR will be submitted to this repository.
Related GSC Resources
Google Docs
- Making a MIXS major release in GitHub - Current manual release instructions
- GSC TWG Meeting Notes 2022 - Release workflow discussions
- MIxS LinkML release SOP - SOP document referenced in SOP for MIxS release #1015
Related GitHub Issues in this repo
- SOP for MIxS release #1015 - SOP for MIxS release (workflow phases documentation)
- Release process #120 - Release process
- Set up autogenerated release notes #356 - Set up autogenerated release notes
- Change log to be included with new releases #537 - Change log to be included with new releases
- MIxS review and release policy #717 - MIxS review and release policy
- Document notification process for releases #741 - Document notification process for releases
- A table of release dates for each MIxS release should be prominently displayed on the MIxS repo landing page or a GSC web page #835 - Table of release dates should be prominently displayed
Related PRs in this repo
- DO NOT MERGE Add script to compare MIxS schema releases using GitHub API #1026 - Schema diff script (marked DO NOT MERGE - development version)
Planned Automation Features
-
Manual dispatch workflow with parameters:
- Version number (e.g., "6.2.1" or "7.0.0")
- Diff comparison range (default: mixs6.0.0 vs main)
-
Automated steps:
- Version bump in pyproject.toml, CITATION.cff, .zenodo.json, release/README.md
- Run `make install clean all test`
- Generate schema diff report (structured YAML)
- Create release PR with all artifacts
- (Future) Generate LLM-based narrative summary of changes
-
New metadata files:
- `CITATION.cff` - GitHub citation support
- `.zenodo.json` - Automatic DOI generation via Zenodo
-
Cleanup:
- Disable unused PyPI publishing workflow
Current Status
Development in progress at turbomam#106
Sub-issues for incomplete work:
- Add LLM-generated narrative summary to release workflow turbomam/mixs#107 - LLM narrative summary
- Test diff script locally before merging turbomam/mixs#109 - Test diff script
- Configure Zenodo integration for automatic DOI generation turbomam/mixs#111 - Zenodo setup
Target
First automated release: v6.2.1 (diff against mixs6.0.0)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels