Deprecation Policy

Compare API/ABI surfaces between refs, flag incompatible changes, and generate deprecation/changelog notes for library projects

jmagly Updated

File contents

Deprecation Policy

Compare public API/ABI surfaces and enforce the api-abi-stability rule for library and SDK projects. This maps curl Practice 26 into AIWG release governance.

Language Strategies

  • C/C++: compare exported headers, function prototypes, struct layout, and symbol lists.
  • Rust: integrate cargo public-api where available; report removed exported items.
  • Go: run apidiff from golang.org/x/exp/cmd/apidiff.
  • TypeScript: use api-extractor or declaration-file diffs.

Output

The report classifies changes as additive, compatible, deprecated, removal, ABI-breaking, or experimental. It also drafts changelog text for each deprecation or removal.

Composition

Use with flow-change-control for request-level approval. This skill owns the API/ABI technical check and release-note evidence.

References

  • agentic/code/frameworks/security-engineering/rules/api-abi-stability.md
  • SemVer
  • curl ABI policy

jmagly/ai-writing-guide/tree/main/agentic/code/plugins/security-engineering/skills/deprecation-policy commit 2a22eee963

Frequently asked questions

npx skillmds@latest add jmagly-ai-writing-guide/deprecation-policy