diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md index e8730f4952..a88ca99382 100644 --- a/RELEASE_CHECKLIST.md +++ b/RELEASE_CHECKLIST.md @@ -241,8 +241,6 @@ Start following the steps below to start a release PR. The process is **not ful - Run our compliance checks and update the `licenses.html` file as appropriate. - Ensure we're not using any incompatible licenses in the release. -7. **MANUALLY CHECK AND UPDATE** the `federation-version-support.mdx` to make sure it shows the version of Federation which is supported by the Routter. - 11. Now, review and stage he changes produced by the previous step. This is most safely done using the `--patch` (or `-p`) flag to `git add` (`-u` ignores untracked files). ``` diff --git a/apollo-federation/README.md b/apollo-federation/README.md index 24f3e71314..29c5390473 100644 --- a/apollo-federation/README.md +++ b/apollo-federation/README.md @@ -25,7 +25,7 @@ Any version may have breaking API changes, as this API is expected to only be u Instead, the version number matches exactly that of the `apollo-router` crate version using it. This version number is **not** that of the Apollo Federation specification being implemented. -See [Router documentation](https://www.apollographql.com/docs/router/federation-version-support/) +See the [Apollo Federation Changelog](https://www.apollographql.com/docs/graphos/schema-design/federated-schemas/reference/versions) for which Federation versions are supported by which Router versions. ## Contributing diff --git a/apollo-federation/src/lib.rs b/apollo-federation/src/lib.rs index 6eaf722026..253c94a350 100644 --- a/apollo-federation/src/lib.rs +++ b/apollo-federation/src/lib.rs @@ -10,7 +10,7 @@ //! Instead, the version number matches exactly that of the `apollo-router` crate version using it. //! //! This version number is **not** that of the Apollo Federation specification being implemented. -//! See [Router documentation](https://www.apollographql.com/docs/router/federation-version-support/) +//! See the [Apollo Federation Changelog](https://www.apollographql.com/docs/graphos/schema-design/federated-schemas/reference/versions) //! for which Federation versions are supported by which Router versions. #![warn( diff --git a/docs/source/routing/federation-version-support.mdx b/docs/source/routing/federation-version-support.mdx index a9960e5bc1..d2a118b2c4 100644 --- a/docs/source/routing/federation-version-support.mdx +++ b/docs/source/routing/federation-version-support.mdx @@ -1,13 +1,10 @@ --- title: Federation Version Support subtitle: Check router version compatibility with Apollo Federation versions -description: This reference shows which version of Apollo Federation each GraphOS Router and Apollo Router Core release is compiled against. Ensure your router uses at least the listed federation version. +description: This reference explains how to check that your router uses at least the minimum required federation version. --- -The GraphOS Router and Apollo Router Core support supergraph schemas that are generated via Apollo Federation 2.x [composition](/federation/federated-types/composition/). This composition algorithm is usually performed by one of the following: - -* Apollo GraphOS (for supergraphs that use [managed federation](/federation/managed-federation/overview/)) -* The Rover CLI (for _non_-managed supergraphs) +The GraphOS Router and Apollo Router Core support supergraph schemas that are generated via Apollo Federation 2.x [composition](/federation/federated-types/composition/). This composition algorithm can be performed by Apollo GraphOS Studio, the Rover CLI, or the Apollo GraphOS Platform API. Apollo Federation is an evolving project, and its composition algorithm regularly receives new features and bug fixes. @@ -17,409 +14,9 @@ Update your router regularly to the latest stable version to ensure that it full -## Support table - -The table below shows which version of federation each router release is compiled against. Make sure that your router's federation version is _at least_ as recent as the version used to compose your supergraph schema. - - - -**Avoid router versions marked with ⚠️.** These versions include bugs described in the [changelog](https://github.com/apollographql/router/blob/main/CHANGELOG.md). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Router versionFederation version
- v2.0.0 and later (see latest releases) - - 2.9.3 -
- v1.57.0 - v1.60.0 - - 2.9.3 -
- v1.56.0 - - 2.9.2 -
- v1.55.0 - - 2.9.1 -
- v1.52.1 - v1.53.0 - - 2.9.0 -
- v1.52.1 - - 2.8.5 -
- v1.49.0 - v1.52.0 - - 2.8.1 -
- v1.48.0 - v1.49.0 - - 2.8.0 -
- v1.46.0 - v1.47.0 - - 2.7.5 -
- v1.45.1 - - 2.7.2 -
- ⚠️ v1.45.0 - - 2.7.2 -
- v1.39.0 - v1.44.0 - - 2.7.1 -
- v1.38.0 - - 2.6.3 -
- v1.36.0 - v1.37.0 - - 2.6.2 -
- v1.35.0 - - 2.6.1 -
- v1.34.1 - - 2.5.7 -
- v1.33.0 - v1.34.0 - - 2.5.5 -
- v1.30.0 - v1.32.0 - - 2.5.4 -
- ️v1.29.1 - - 2.5.3 -
- ⚠️ v1.29.0 - - 2.5.3 -
- ⚠️ v1.28.0 - v1.28.1 - - 2.5.1 -
- v1.25.0 - v1.27.0 - - 2.4.10 -
- v1.24.0 - - 2.4.9 -
- v1.21.0 - v1.23.0 - - 2.4.8 -
- v1.20.0 - - 2.4.7 -
- ️⚠️ v1.19.1 - - 2.4.6 -
- ⚠️ v1.19.0 - - 2.4.5 -
- v1.16.0 - v1.18.1 - - 2.4.2 -
- v1.15.0 - v1.15.1 - - 2.4.1 -
- v1.13.1 - v1.14.0 - - 2.4.0 -
- v1.11.0 - v1.13.0 - - 2.3.2 -
- v1.10.2 - v1.10.3 - - 2.3.1 -
- ⚠️ v1.10.1 - - 2.3.1 -
- ⚠️ v1.10.0 - - 2.3.0 -
- v1.6.0 - v1.9.0 - - 2.2.2 -
- v1.2.1 - v1.5.0 - - 2.1.4 -
- v1.0.0 - v1.2.0 - - 2.1.3 -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Router versionFederation version
- v1.0.0-rc.1 and v1.0.0 - - 2.1.2-alpha.2 -
- v1.0.0-rc.0 - - 2.1.2-alpha.1 -
- v1.0.0-alpha.3 - - 2.1.2-alpha.0 -
- v1.0.0-alpha.1 - v1.0.0-alpha.2 - - 2.1.1 -
- v0.16.0 - v1.0.0-alpha.0 - - 2.1.0-alpha.4 -
- v0.9.0 – v0.15.1 - - 2.0.2 -
- v0.1.0-preview.5 – v0.1.0-preview.7 - - 2.0.1 -
- v0.1.0-preview.4 - - 2.0.0 -
- v0.1.0-preview.3 - - 2.0.0-preview.7 -
+## Checking version compatibility - +To ensure your router's federation version is supported, check the [Apollo Federation Changelog](/graphos/schema-design/federated-schemas/reference/versions). Make sure that your router's federation version is _at least_ as recent as the version used to compose your supergraph schema. ## Federation 1 support