Skip to content

P2: Declare 1.0.0 + versioning & schema stability policy (#178)#198

Open
dkijania wants to merge 1 commit into
mainfrom
chore/v1-and-schema-policy
Open

P2: Declare 1.0.0 + versioning & schema stability policy (#178)#198
dkijania wants to merge 1 commit into
mainfrom
chore/v1-and-schema-policy

Conversation

@dkijania

Copy link
Copy Markdown
Contributor

What & why

Part of the production-readiness epic (#163). Closes #178.

The package was pre-1.0 (0.0.6) with no documented stability guarantees — public consumers need them.

Changes

  • Bump to 1.0.0 in package.json.
  • docs/versioning.md — SemVer applied to the GraphQL schema / HTTP endpoints / config: a precise definition of breaking vs additive changes, a deprecation policy (@deprecated + one minor & 90 days before removal), and how the existing graphql-inspector "Check Schema" gate enforces it via the expected-breaking-change label.
  • Linked the policy from the README.

Important: this PR does not publish anything

The version bump is package.json-only — no git tag, so no release is cut. Publishing is tag-triggered (npm version + git push --follow-tags) and remains a deliberate maintainer action. Treat merging this PR as the decision to declare 1.0; if you're not ready for that, hold the PR (the policy doc stands on its own). Sequence it after the other production-readiness PRs so 1.0.0 ships with them.

Testing

Docs + version only. prettier --debug-check . clean; build sane. No code changed.

🤖 Generated with Claude Code

The package was pre-1.0 (0.0.6) with no documented stability guarantees, which
public consumers need.

- Bump version to 1.0.0 (package.json only — no tag; the actual release/publish
  remains a deliberate maintainer step via `npm version` + tag push).
- Add docs/versioning.md: SemVer applied to the GraphQL schema / HTTP endpoints /
  config, a precise definition of breaking vs additive changes, a deprecation
  policy (@deprecated + one minor & 90 days before removal), and how the existing
  graphql-inspector "Check Schema" gate enforces it via the
  expected-breaking-change label.
- Link the policy from the README.

Closes #178.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QSuak9smCHbp4N17xjjLF6
@dkijania dkijania added documentation Improvements or additions to documentation production-readiness Work toward making the API production-ready / publicly available P2 GA polish / hygiene labels Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation P2 GA polish / hygiene production-readiness Work toward making the API production-ready / publicly available

Projects

None yet

Development

Successfully merging this pull request may close these issues.

P2: Cut 1.0.0 + schema stability / deprecation policy

1 participant