AGENT SKILL

changesets

Use when a PR changes any released package (crates/*, sdk/typescript, sdk/python, packages/edit-tools), when the changeset-gate CI check fails, when adding a new crate or package to the release config, or when working on knope versioning/release automation. For the step-by-step workflow to add a change file, use $create-changeset.

License 许可
MIT
所属仓库
RoderAI/roder
最近更新
2026-11-13
Stars
★ 9
Forks
1

01 前言 Front Matter

name
changesets
description
Use when a PR changes any released package (crates/*, sdk/typescript, sdk/python, packages/edit-tools), when the changeset-gate CI check fails, when adding a new crate or package to the release config, or when working on knope versioning/release automation. For the step-by-step workflow to add a change file, use $create-changeset.

03 SKILL.md 正文

Changesets & per-package versioning (knope)

This repo versions every Cargo crate and SDK package independently using knope with changesets. Commit messages never bump versions; only .changeset/*.md files do. Full docs: docs/releases.md.

Adding a changeset for a PR: use $create-changeset — it walks through detecting touched packages, writing the file, verifying locally, and committing.

Add a changeset (required by CI)

Any PR touching files under a released package's directory must add a change file in .changeset/:

---
roder-core: minor
roder: patch
---

# Short summary used in changelogs and release notes
  • One file per logical change; name it descriptively, e.g. .changeset/add_mcp_streaming.md.
  • Package names = keys in knope.toml (crate names; SDKs are roder-sdk-typescript, roder-sdk-python, roder-edit-tools).
  • Bump types: major | minor | patch. With this knope configuration, pre-1.0 breaking changes require major (for example, 0.2.x to 0.3.0); minor and patch both advance the final component. Include the compatible reverse dependency closure when shared Rust API types change.
  • Never put non-changeset .md files (READMEs etc.) in .changeset/.
  • Commit the changeset — CI only counts files in the branch diff.

Verify locally before pushing:

python3 scripts/check-changesets.py --base origin/master

Test-only or comment-only changes inside a package can bypass the gate with the skip-changeset PR label instead of a changeset.

Adding a crate or package

  1. New crates get an explicit version = "0.1.0" in Cargo.toml — the workspace has no shared version, do not use version.workspace = true.

  2. Regenerate the release config (CI checks it's current):

    python3 scripts/generate-knope-config.py
    
  3. Non-Rust packages: add to EXTRA_PACKAGES in scripts/generate-knope-config.py first.

  4. knope.toml is generated — never edit it by hand.

How releases happen (context)

  • Push to master → prepare-release.yml runs knope prepare-release, which consumes pending changesets, bumps affected packages, updates their CHANGELOG.mds, and maintains the knope/release preview PR.
  • Merging that PR → release.yml runs knope release, tagging <package>/v<version> and creating one GitHub release per package.
  • CLI npm publication and binary/Homebrew distribution run in release CI. Crates.io and SDK registry publication are separate explicit steps; see docs/releases.md.
  • Baseline tags for unreleased packages: python3 scripts/init-release-tags.py or the "Baseline release tags" workflow.

04 同仓库更多 Skills