Skip to content

Add automated release workflow for MIxS #1081

@turbomam

Description

@turbomam

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

Related GitHub Issues in this repo

Related PRs in this repo

Planned Automation Features

  1. 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)
  2. 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
  3. New metadata files:

    • `CITATION.cff` - GitHub citation support
    • `.zenodo.json` - Automatic DOI generation via Zenodo
  4. Cleanup:

    • Disable unused PyPI publishing workflow

Current Status

Development in progress at turbomam#106

Sub-issues for incomplete work:

Target

First automated release: v6.2.1 (diff against mixs6.0.0)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions