Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update @apollo/subgraph CHANGELOG.md entry for 2.3.0-beta.2 #2386

Merged
merged 2 commits into from
Feb 8, 2023
Merged

Update @apollo/subgraph CHANGELOG.md entry for 2.3.0-beta.2 #2386

merged 2 commits into from
Feb 8, 2023

Conversation

sachindshinde
Copy link
Contributor

@sachindshinde sachindshinde commented Feb 8, 2023 •
edited
Loading

We've seen folks accidentally forgetting to bump their federation spec to v2.3 when using the latest @tag directive definition that includes SCHEMA, which will result in an error from buildSubgraphSchema() (see #2375 ). This PR updates the CHANGELOG.md to explicitly state this.

@sachindshinde
Update @apollo/subgraph CHANGELOG.md entry for 2.3.0-beta.2 to mentio…
65c7d7d 
…n that using @tag with the new location requires using the federation 2.3 spec.
@netlify
Copy link

netlify bot commented Feb 8, 2023 •
edited
Loading

👷 Deploy request for apollo-federation-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 388f5ec

@changeset-bot
Copy link

changeset-bot bot commented Feb 8, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 388f5ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Feb 8, 2023 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

trevor-scheer
trevor-scheer approved these changes Feb 8, 2023
View reviewed changes
Copy link
Member

@trevor-scheer trevor-scheer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably also helpful to update the PR description to reference the issue

subgraph-js/CHANGELOG.md Outdated
@@ -9,7 +9,7 @@
This CHANGELOG pertains only to Apollo Federation packages in the 2.x range. The Federation v0.x equivalent for this package can be found [here](https://github.com/apollographql/federation/blob/version-0.x/subgraph-js/CHANGELOG.md) on the `version-0.x` branch of this repo.

## 2.3.0-beta.2
- `@tag` directive support for the `SCHEMA` location [PR #2314](https://github.com/apollographql/federation/pull/2314).
- `@tag` directive support for the `SCHEMA` location. This has been added to the 2.3 version of the federation spec, and you must declare usage of this spec version in your subgraph to use this functionality. [PR #2314](https://github.com/apollographql/federation/pull/2314).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we be extra clear on the action item that's required for users? (you need to bump your @link federation spec version to v2.3 in your type definitions)

Providing a snippet certainly would remove any uncertainty.

@link(url: "https://specs.apollo.dev/federation/v2.3", import: [...])

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@trevor-scheer Makes sense, made it more explicit in the entry. (I also removed the import since it's not strictly needed to run into this issue.)

@sachindshinde sachindshinde force-pushed the sachin/update-fed23-subgraph-changelog branch from 0e8e1ae to 388f5ec Compare February 8, 2023 18:56
@sachindshinde sachindshinde merged commit 3a63718 into apollographql:main Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trevor-scheer trevor-scheer trevor-scheer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sachindshinde @trevor-scheer