Skip to content

SKILL.md

Latest commit

 

History

History
99 lines (78 loc) · 2.39 KB

SKILL.md

File metadata and controls

99 lines (78 loc) · 2.39 KB

Release Skill

Executes a full release cycle for the riddl project. Follow each step in order. STOP immediately if any assertion fails and report the problem.

Arguments

The user should provide a version number (e.g., 1.10.1). If not provided, analyze changes since the last tag and recommend a version bump per semver (MAJOR/MINOR/PATCH), then wait for the user to confirm.

Pre-Flight Checks

  1. Assert current branch is main:

    git branch --show-current

    If not on main, ask the user before switching. Never publish from development or feature branches.

  2. Assert working tree is clean:

    git status --porcelain

    If dirty, list the uncommitted files and ask the user how to proceed.

  3. Unset GITHUB_TOKEN to avoid auth conflicts:

    unset GITHUB_TOKEN

  4. Verify the version tag does not already exist:

    git tag -l <VERSION>

Release Steps

  1. Run the full test suite and confirm all tests pass:

    sbt clean test

  2. Create an annotated git tag:

    git tag -a <VERSION> -m "Release <VERSION>"

  3. Push the tag to origin:

    git push origin <VERSION>

  4. Publish all modules to GitHub Packages:

    sbt clean test publish

    Verify the published version matches <VERSION> in the sbt output (sbt-dynver derives version from the tag).

  5. Create a GitHub release:

    gh release create <VERSION> --title "Release <VERSION>" \
  --generate-notes

    This triggers the Release Artifacts workflow (native builds, Homebrew formula update) and the npm-publish workflow automatically.

Post-Release Verification

  1. Run git status to confirm the working tree is still clean.

  2. Confirm the release exists:

    gh release view <VERSION>

  3. Switch back to development and merge the tag forward:

    git checkout development
git merge main
git push

  4. Report a summary: tag, commit SHA, release URL, and any CI workflows triggered.

If Something Fails

  • If tests fail in step 5: fix and re-run. Do NOT proceed.
  • If tag push fails in step 7: check if the tag exists remotely.
  • If publish fails in step 8: check credentials and retry.
  • If gh release create fails in step 9: the tag is already pushed, so the release can be created manually or retried.
  • Never force-push tags without explicit user approval.