agentleFS
Sign inStart free
anandartinanandartin/celestial-skills/skills/release-and-versioning-engineering/AGENTS.md

celestial-skills / release-and-versioning-engineering

AGENTS.md1 starsChanged 18 days agoApache-2.0View on GitHub

Semantic versions, a human-written changelog and tagged releases, so users know what changed and whether upgrading is safe. Generated from the Celestial engineering practice “Release and versioning”.

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Never move or reuse a published tag or version number.

    line 24

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “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
AGENTS.md

AGENTS.md — Release and versioning

Semantic versions, a human-written changelog and tagged releases, so users know what changed and whether upgrading is safe.

How to do it

  1. Define the public surface — Write down what counts as the public API: exported functions, CLI flags and exit codes, HTTP routes and response shapes, config keys. Only changes to this surface affect the major version.
  2. Write commits with a type — Use type(scope): summary, e.g. feat, fix, perf, docs, refactor. Mark breaking changes with ! after the type and a BREAKING CHANGE footer explaining the migration.
  3. Add to the Unreleased changelog section in the same pull request — Under Added, Changed, Deprecated, Removed, Fixed or Security, write one line in user terms: what they can now do or what behaves differently. Skip internal refactors.
  4. Choose the next version — Breaking change → major; new backward-compatible feature → minor; fix only → patch. Before 1.0.0, say in the README how breaking changes are handled.
  5. Cut the release — Move Unreleased entries under the new version with today's date, bump the version in the manifest, and merge that change. Create an annotated tag vX.Y.Z on the merge commit.
  6. Publish from CI — The tag triggers a pipeline that builds, attaches checksums and provenance, publishes to the registry and creates release notes from the changelog section.
  7. Write release notes for humans — Lead with breaking changes and the migration steps, then highlights, then the full list. Link each item to its pull request.
  8. Deprecate before removing — Mark the old behaviour deprecated with a runtime warning and a changelog entry in a minor release; remove it no sooner than the next major.

Checklist (before a pull request)

  • Version number follows MAJOR.MINOR.PATCH and matches the change type
  • CHANGELOG.md has a dated section for this version with user-facing entries
  • Every breaking change has migration steps in the notes
  • An annotated tag vX.Y.Z points at the released commit
  • The published artifact was built by CI from that tag
  • Release notes link to the pull requests included

Rules

  • Never move or reuse a published tag or version number; ship a new patch instead. (Anyone who already pulled the old artifact would silently differ from everyone else.)
  • Publish only from CI with registry tokens stored as pipeline secrets and scoped to publishing. (Laptop releases can include local changes and leak credentials.)
  • The version lives in one place (the package manifest) and everything else reads it. (Two version strings drift apart.)
  • A bad release is fixed forward with a new patch and, where the registry supports it, the bad version is deprecated or yanked. (Deleting a release breaks lock files that already reference it.)

Checks

GateToolThresholdWhen
Changelog entryCI check on pull requests touching src/CHANGELOG.md Unreleased section changed, or a skip-changelog label with a reasonEvery pull request
Commit formatCommit message linterPull request title follows type(scope): summaryEvery pull request

Generated from the Celestial engineering practice “Release and versioning”.

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.

Check your setup, free