agentleFS
kennguyen887kennguyen887/agent-foundation/skills/release-safety/SKILL.md

release-safety

Skill1 starsChanged 5 months agoMITView on GitHub

Use before cutting or deploying a backend release (or reviewing release readiness) — backward compatibility with the current production app, testing the current app against the new backend, rollback plan, config/data readiness, feature flags & observability, and the code-comment policy for transition logic.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

16 rules. About 0 are common, 14 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈14

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every backend release MUST work with BOTH the current production app and the new app — there's always a gap between backend deploy and app …

    line 15
  2. Distinctive:

    Only additive migrations per release (add columns, add tables).

    line 19
  3. Distinctive:

    NEVER rename or drop columns in the same release as the feature using them.

    line 20
  4. Distinctive:

    Don't remove/break old fields or endpoints until the old app version is fully deprecated.

    line 25
  5. Distinctive:

    Code requirement: when introducing backward-compatible logic, add a comment explaining why it's needed, which app versions are affected, …

    line 27
  6. Distinctive:

    Before every release — including force-update releases — verify the current production app version works against the new backend.

    line 31
  7. Distinctive:

    Every release requires a documented rollback plan before it ships, answering:

    line 36
  8. Distinctive:

    If not, what's the forward-fix strategy?

    line 38
  9. Distinctive:

    Do not release if any of the above is undefined.

    line 42
  10. Distinctive:

    NEVER assume staging DB, config, or seed data matches production — verify explicitly.

    line 45
  11. Distinctive:

    Treat code readiness, DB migration readiness, and config readiness as three separate checks.

    line 47
  12. Distinctive:

    Keep a golden staging/UAT dataset covering critical flows and known edge cases.

    line 49
  13. Distinctive:

    Don't rely on staging-only assumptions or seed data in production code paths.

    line 50
  14. Very specific:

    Use feature flags for high-risk business-logic changes — do not gate on NODE_ENV.

    line 53
  15. Distinctive:

    Add logs and alerts on every critical rule branch, fallback path, missing config, unexpected behavior.

    line 54
  16. Very specific:

    Add code comments only when needed for: backward compatibility (affected versions + when removable), migration safety (what state the DB …

    line 58

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
SKILL.md

Release safety

Core principle: a backend release is valid only if the current production app keeps working after it deploys. Any change that breaks the current app version is an invalid release — regardless of whether a force update is planned.

1. Backend backward compatibility

Every backend release MUST work with BOTH the current production app and the new app — there's always a gap between backend deploy and app rollout.

Database changes:

  • Only additive migrations per release (add columns, add tables).
  • NEVER rename or drop columns in the same release as the feature using them.
  • Sequence: add column → update reads/writes → remove old column in a later release.

API changes:

  • Preserve existing API contracts (fields, response shapes, endpoints).
  • Don't remove/break old fields or endpoints until the old app version is fully deprecated.

Code requirement: when introducing backward-compatible logic, add a comment explaining why it's needed, which app versions are affected, and when the old logic/fields can be removed.

2. Test current app against new backend

Before every release — including force-update releases — verify the current production app version works against the new backend. Run all critical user flows with the current app pointed at the new backend. If any critical flow fails: block the release, fix the backend, re-test. No exceptions.

3. Rollback plan

Every release requires a documented rollback plan before it ships, answering:

  • Can the previous backend version be redeployed safely?
  • If not, what's the forward-fix strategy?
  • Who is the rollback owner (authority to trigger it)?
  • What are the rollback conditions (error-rate threshold, critical failure types)?

Do not release if any of the above is undefined.

4. Config & data readiness

  • NEVER assume staging DB, config, or seed data matches production — verify explicitly.
  • Validate all critical config at startup; fail fast if missing/invalid — no silent fallbacks.
  • Treat code readiness, DB migration readiness, and config readiness as three separate checks.
  • Explicitly verify partner settings, category mappings, plan settings, and other business config.
  • Keep a golden staging/UAT dataset covering critical flows and known edge cases.
  • Don't rely on staging-only assumptions or seed data in production code paths.

5. Feature flags & observability

  • Use feature flags for high-risk business-logic changes — do not gate on NODE_ENV.
  • Add logs and alerts on every critical rule branch, fallback path, missing config, unexpected behavior.
  • Post-release verification is mandatory for critical flows — smoke-test before AND after release.

6. Code comment policy (transition logic)

Add code comments only when needed for: backward compatibility (affected versions + when removable), migration safety (what state the DB must be in), release safety (deploy-order requirement), or temporary transition logic (TODO: remove after <version>).

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.