Skip to content

docs: declare v1beta1 stable for v1.0 and add v1.0.x compatibility row - #2270

Merged
missBerg merged 4 commits into
envoyproxy:mainfrom
missBerg:claude/pensive-moser-8b470a
Jun 22, 2026
Merged

docs: declare v1beta1 stable for v1.0 and add v1.0.x compatibility row#2270
missBerg merged 4 commits into
envoyproxy:mainfrom
missBerg:claude/pensive-moser-8b470a

Conversation

@missBerg

Copy link
Copy Markdown
Contributor

Description

Prepare release documentation for the upcoming v1.0.0 release. Docs-only change in two parts:

  • RELEASES.md — record the API stability commitment that motivates the major version bump. As of v1.0.0, v1beta1 is the committed stable control-plane API and is covered by the existing "never break unless critical security" guarantee. v1alpha1 remains served but deprecated and will be removed in a future release per the deprecation policy. QuotaPolicy stays v1alpha1-only and is therefore outside the stable surface; in particular its serviceQuota field is accepted but not yet enforced end-to-end.
  • site/docs/compatibility.md — add the v1.0.x row to the compatibility matrix (Envoy Gateway v1.8.x+, Envoy Proxy v1.38.x, Kubernetes v1.32+, Gateway API v1.5.x).

No API, controller, or data-plane code changes.

AI usage: these docs were drafted with assistance from Claude (Claude Code) and reviewed by the author.

Related Issues/PRs (if applicable)

Special notes for reviewers (if applicable)

This is forward-looking v1.0 release-prep. The new v1.0.x compatibility row is marked Supported and the RELEASES.md wording says "as of the v1.0.0 release", even though v1.0.0 has not been tagged yet. Intent is for this to land as part of, or immediately before, the v1.0 cut rather than necessarily merging standalone today.

Two items intentionally left to maintainers:

  • EOL rolling in the compatibility matrix. With the v0.7 to v1.0 major jump, which of v0.7.x / v0.6.x / v0.5.x roll to End of Life is a judgment call; this PR only adds the v1.0.x row and does not change existing support statuses.
  • The serviceQuota docs accuracy fix tracked on the docs/quota-policy-accuracy branch is complementary to the RELEASES.md note added here.

@missBerg
missBerg requested a review from a team as a code owner June 22, 2026 13:51
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jun 22, 2026
@missBerg missBerg added this to the v1.0.0 milestone Jun 22, 2026
Comment thread site/docs/compatibility.md Outdated
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.70%. Comparing base (67e4926) to head (f0d60ba).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2270      +/-   ##
==========================================
- Coverage   84.71%   84.70%   -0.01%     
==========================================
  Files         144      144              
  Lines       21204    21206       +2     
==========================================
  Hits        17962    17962              
- Misses       2161     2162       +1     
- Partials     1081     1082       +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

missBerg and others added 2 commits June 23, 2026 00:02
Prepare release documentation for the upcoming v1.0.0 release:
- RELEASES.md: state that v1beta1 is the committed stable control-plane API
  as of v1.0.0, that v1alpha1 stays served + deprecated, and that
  QuotaPolicy/serviceQuota sits outside the stable surface (accepted but not
  yet enforced end-to-end).
- site/docs/compatibility.md: add the v1.0.x compatibility row (EG v1.8.x+,
  Envoy v1.38.x, K8s v1.32+, Gateway API v1.5.x).

Drafted with assistance from Claude (Claude Code).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com>
Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com>
@missBerg
missBerg force-pushed the claude/pensive-moser-8b470a branch from 1c794db to c1bcda0 Compare June 22, 2026 22:02
@missBerg
missBerg enabled auto-merge (squash) June 22, 2026 22:06
@missBerg
missBerg merged commit 2721126 into envoyproxy:main Jun 22, 2026
25 checks passed
missBerg added a commit to missBerg/ai-gateway that referenced this pull request Jun 22, 2026
After merging upstream/main, sync version-1.0/compatibility.md to match
docs/compatibility.md so the v1.0 snapshot uses the same wording landed in
envoyproxy#2270 (Envoy Gateway "v1.8.1+" on the main and v1.0.x rows).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com>
missBerg added a commit to missBerg/ai-gateway that referenced this pull request Jun 23, 2026
Remove the pre-release draft comment block and inline TODOs now that each is
resolved:
- date set (June 23) and the real GA hero image is in place;
- name v1beta1 as the stable control-plane API (1.0 ratifies it, no apiVersion
  bump), matching RELEASES.md/envoyproxy#2270 and the v1.0 release notes;
- the feature highlights match the v1.0 release-notes surface;
- the named adopters (Bloomberg, LY Corporation, Alan by Comma Soft, National
  Research Platform) are all publicly listed in site adopters.json.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com>
missBerg added a commit that referenced this pull request Jun 23, 2026
**Description**

v1.0 GA documentation for the docs site. This is the project's first GA
/ major-version release, so the release notes are written as a special
milestone edition rather than a normal incremental delta.

What's included:

- **Release notes (special GA edition).**
`site/src/data/releases/v1.0.json` and
`site/src/pages/release-notes/v1.0.mdx`. On top of the standard sections
it adds GA-specific ones: a "What 1.0 Means" intro, an API-stability
commitment callout, a "Road to 1.0" journey grid, and a Support &
Compatibility Policy section. The framing is that v1.0 ratifies the
existing `v1beta1` control-plane API as stable under SemVer — no
apiVersion change and no resource migration, so upgrading from v0.7 is a
drop-in.
- **Versioned 1.0 docs.** The docs are snapshotted as
`versioned_docs/version-1.0` and set as the default/latest version
(`versions.json` + `docusaurus.config.ts`), including the QuotaPolicy
capability guide from #1947.
- **Plain-markdown release body** in `release-notes/v1.0.0.md` for the
GitHub release.
- **Announcement blog post** under `site/blog/2026/`, with a GA
announcement/OG image and credited to all nine maintainers via the
Docusaurus authors mechanism.
- **Wiring**: v1.0 added to the release-notes index (featured) and the
v0.7 to v1.0 navigation link.

Dependency versions are sourced from `go.mod` and `.envoy-version`: Go
1.26.4, Envoy Gateway v1.8.1, Envoy 1.38.1, Gateway API v1.5.1, Gateway
API Inference Extension v1.0.2, MCP Go SDK v1.6.1.

AI assistance: this documentation was prepared with the help of Claude
Code (Claude Opus 4.8) and reviewed before submission.

**Related Issues/PRs (if applicable)**

Related: #1947 (QuotaPolicy capability guide), #2270 (v1beta1 stable
declaration + compatibility row).

**Special notes for reviewers (if applicable)**

The release notes, index cards, and blog are dated June 23, 2026 —
please confirm this matches the actual v1.0.0 tag date at the cut and
adjust if needed. This is intended to land as part of, or immediately
before, the v1.0.0 release.

---------

Signed-off-by: Erica Hughberg <erica.sundberg.90@gmail.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants