agentleFS
MistakeyMistakey/simulink-automation-suite/.claude/skills/release/SKILL.md

release

Skill9 starsChanged 8 months agoMITView on GitHub

This skill should be used when the user asks to "release a new version", "bump version", "create release tag", "update release notes", "prepare release", or performs any release-related operation for the simulink-automation-suite plugin.

  • Commits and pushes

193 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-agent-adapter, changelog-style and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    create-agent-adapter

    Technical guide for creating a new Paperclip agent adapter. Use when building a new adapter package, adding support for a new AI coding tool (e.g. a new CLI agent, API-based agent, or custom process), or when modifying the adapter system. Covers the required interfaces, module structure, registration points, and conventions derived from the existing claude-local and codex-local adapters.

    Also in 5 projects that use this

  • GrinvSkill

    changelog-style

    Turn a commit range into CHANGELOG.md entries following common-changelog style. Use when finishing a PR or cutting a release, to write/fix the [Unreleased] section's entries — moving [Unreleased] under a new dated version heading is a separate, automated step (see the release skill / scripts/sync-version.ts), not this skill's job.

    Also in 4 projects that use this

  • GrinvSkill

    docs-consistency-check

    Check README/manifest.json/server.json/CHANGELOG.md/AGENTS.md and docs/*.md for drift against the actual registered tools and source. Use after adding, renaming, or removing a tool, or as part of a live-audit pass.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    component-release

    Prepares a verifiable Agent Landing Zone UI release. Use for release branches, VERSION, changelog entries, tags, release notes, and compatibility evidence; never publish without explicit human approval.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    documentation-consistency

    Keeps AI Landing Zone contributor, user, and operator documentation aligned with shipped Bicep behavior. Use for parameters, defaults, outputs, topology, deployment flow, operations, or releases.

    Also in 8 projects that use this

  • rivet-devSkill

    launch-graphics

    Generate agentOS marketing/launch graphics (launch & social heroes, code-snippet cards) from the committed generators in docs-internal/graphics. Use when asked to make, update, or render an agentOS launch image, social image, "agentOS Apps" graphic, or technical code-snippet image.

    Also in 3 projects that use this

  • +3 more from Grinv

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. 0 are common, 8 are distinctive, and 7 are very specific to this project.

  • 0

    Common

    Most of the 183 edited versions we read keep these.

  • 8

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Default release path is tag-driven GitHub auto release via .github/workflows/release.yml.

    line 8
  2. Distinctive:

    Update manifests and schema:

    line 23
  3. Very specific:

    Check report's Test Commit vs current HEAD

    line 40
  4. Very specific:

    If close match: copy to docs/reports/archive/live-test-vX.Y.Z.md

    line 41
  5. Distinctive:

    If large gap: warn "Live test report may be stale" — user decides

    line 42
  6. Distinctive:

    If no report exists: warn "No live test report.

    line 44
  7. Distinctive:

    Create and push annotated tag:

    line 47
  8. Distinctive:

    Do not leave shipped behavior changes on an old version with a plan to "bump later".

    line 86
  9. Very specific:

    Curated: use docs/release/ document whose filename matches vX.Y.Z

    line 98
  10. Very specific:

    Default to a bilingual body in one top-level curated file docs/release/<date>-vX.Y.Z.md:

    line 112
  11. Very specific:

    If too long: keep single top-level file with shorter Chinese summary, link to detailed companion at docs/release/zh-CN/<date>-vX.Y.Z.md.

    line 118
  12. Very specific:

    Do not add a second top-level version-matching file — build_release_notes.py treats multiple matches as an error.

    line 120
  13. Distinctive:

    Run from the branch containing the fix.

    line 129
  14. Distinctive:

    Before releasing, verify all affected artifacts are updated:

    line 146
  15. Distinctive:

    Before finishing release-related work:

    line 158

“Common” is measured: kept by at least 6 in 10 of the 183 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release

Default release path is tag-driven GitHub auto release via .github/workflows/release.yml.

Files to Check First

  1. .claude-plugin/plugin.json
  2. .claude-plugin/marketplace.json
  3. simulink_cli/core.py — build_schema_payload()["version"]
  4. docs/release/
  5. scripts/check_release_metadata.py
  6. scripts/build_release_notes.py
  7. .github/workflows/release.yml

Release Flow

  1. Pick version X.Y.Z
  2. Update manifests and schema:
    • .claude-plugin/plugin.json → version: "X.Y.Z"
    • .claude-plugin/marketplace.json → plugins[0].version: "X.Y.Z"
    • simulink_cli/core.py → build_schema_payload()["version"] to "X.Y" (only when major.minor changes)
    • docs/release/<date>-vX.Y.Z.md when required (see Release Notes section)
  3. Validate locally:
python scripts/check_release_metadata.py --tag vX.Y.Z
python -m unittest tests.test_plugin_manifest_contract tests.test_marketplace_manifest_contract -v
python -m unittest discover -s tests -p "test_*.py" -v
claude plugin validate .
python scripts/build_release_notes.py --tag vX.Y.Z --ref HEAD
  1. Archive live test report (if available):
    • If docs/reports/LIVE-TEST-REPORT.md exists:
      • Check report's Test Commit vs current HEAD
      • If close match: copy to docs/reports/archive/live-test-vX.Y.Z.md
      • If large gap: warn "Live test report may be stale" — user decides
      • Reference archived report in release notes Validation section
    • If no report exists: warn "No live test report. Consider running /live-test first." — do not block release
  2. Commit release changes
  3. Create and push annotated tag:
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin <branch>
git push origin vX.Y.Z
  1. .github/workflows/release.yml creates the GitHub Release automatically

Version Sync Rules

For release version X.Y.Z, all four must match:

LocationRequired Value
.claude-plugin/plugin.json → versionX.Y.Z
.claude-plugin/marketplace.json → plugins[0].versionX.Y.Z
simulink_cli/core.py → build_schema_payload()["version"]X.Y
Git tagvX.Y.Z

scripts/check_release_metadata.py enforces this. Any divergence fails validation.

When To Bump Version

Bump when the change is intended for a distributable release or changes shipped contract behavior.

Requires bump:

  • .claude-plugin/**
  • skills/**
  • README*
  • simulink_cli/**
  • tests/docs that define shipped contract behavior

Does not require bump by itself:

  • .github/workflows/**
  • .claude/rules/**, .claude/skills/**
  • internal planning/docs not shipped with the plugin

Do not leave shipped behavior changes on an old version with a plan to "bump later".

CLI Changes and Schema Version

simulink_cli/core.py is both the runtime schema source and a release metadata input. When CLI contract changes require a new release version, update schema version with the plugin major.minor rule (e.g., plugin 2.3.4 → schema "2.3").

Release Notes

Source Priority

scripts/build_release_notes.py writes the GitHub Release body:

  1. Curated: use docs/release/ document whose filename matches vX.Y.Z
  2. Fallback: generate deterministic notes from git history (no external AI, commit range from highest earlier semver tag, required sections: Summary, Highlights, Compatibility / Upgrade Notes, Validation)

When Curated Notes Are Required

  • Major or minor release
  • Patch that changes user-facing behavior in more than one notable way
  • Upgrade or compatibility guidance needed
  • Behavior that should be summarized more clearly than raw commit subjects

Optional only for trivial metadata-only or emergency republish cases.

Bilingual Strategy

Default to a bilingual body in one top-level curated file docs/release/<date>-vX.Y.Z.md:

  • Full English release notes first
  • Chinese section (## 中文说明) for user-facing summary, highlights, and compatibility guidance
  • Validation may stay English-only

If too long: keep single top-level file with shorter Chinese summary, link to detailed companion at docs/release/zh-CN/<date>-vX.Y.Z.md.

Do not add a second top-level version-matching file — build_release_notes.py treats multiple matches as an error.

workflow_dispatch

Use only when:

  • The tag already exists
  • The original release job failed or was skipped
  • The GitHub Release body must be regenerated after fixing docs or scripts

Run from the branch containing the fix. Do not use as the normal first-publish path.

CI Validation Order

The release workflow runs in this order:

  1. scripts/check_release_metadata.py --tag vX.Y.Z
  2. python -m unittest discover -s tests -p "test_*.py" -v
  3. claude plugin validate . (when available on runner)
  4. Fallback validation when claude unavailable:
    • python -m unittest tests.test_plugin_manifest_contract tests.test_marketplace_manifest_contract -v
    • python scripts/check_release_metadata.py --tag vX.Y.Z
  5. scripts/build_release_notes.py
  6. gh release create or gh release edit

Change Synchronization

Before releasing, verify all affected artifacts are updated:

CLI actions/arguments → update simulink_cli/core.py + simulink_cli/actions/*.py + tests + README.md, README.zh-CN.md, SKILL.md, reference.md

Error codes → reuse existing codes; update simulink_cli/core.py + docs + test_error_contract, test_runtime_error_mapping, test_docs_contract

Output budgets → keep scan→max_blocks,fields, inspect→max_params,fields, connections→max_edges,fields, find→max_results,fields semantics stable; update output-control tests

Release metadata → version-sync per Version Sync Rules above

Agent Checklist

Before finishing release-related work:

  • Tag format is vX.Y.Z
  • Manifest versions match (plugin.json, marketplace.json)
  • Schema version matches plugin major.minor
  • Release notes source is understood (curated vs fallback)
  • Local validation passed
  • No stale docs describing manual-only release flow
  • Live test report reviewed (if available) — no unresolved FAIL items

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.