Upcoming Release Changes #583
Conversation
🚀 Snapshot Release (
|
| Package | Version | Info |
|---|---|---|
@graphql-tools/executor-graphql-ws |
2.0.0-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/gateway |
1.9.2-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
@graphql-mesh/plugin-opentelemetry |
1.3.39-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
@graphql-mesh/plugin-prometheus |
1.3.27-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
@graphql-hive/gateway-runtime |
1.4.11-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
@graphql-mesh/transport-ws |
1.0.0-rc-7759f3d79ac8abb2207692cde94f7adf982c37cd |
npm ↗︎ unpkg ↗︎ |
🚀 Snapshot Release (Binary for
|
🚀 Snapshot Release (Binary for
|
🚀 Snapshot Release (Binary for
|
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis pull request removes several changeset markdown files that documented dependency updates, primarily the upgrade of the Changes
Possibly related PRs
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
d8bd617 to
229fe0d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
packages/executors/graphql-ws/CHANGELOG.md (3)
5-8: Major Changes Description — Consider Wording ImprovementThe major changes section explains that the executor options no longer include the graphql‐ws dependency options. The bullet note at line 7 could be made clearer. For example, consider rephrasing to:
"Executor options no longer include the graphql‐ws dependency options"
This will improve readability and set clear expectations for users.
11-22: Code Example — Clear Demonstration of New Usage PatternThe provided TypeScript code snippet clearly illustrates how to import and use the
buildGraphQLWSExecutoralongsidecreateClientfromgraphql-ws. This example is very useful for users adjusting to the new configuration.
Consider adding a short inline comment (within the snippet) to emphasize that this pattern is required due to the removal of certain dependency options.
24-27: Upgrade Notice for graphql-ws to v6 — Clear and InformativeThis section notifies users that upgrading to graphql-ws v6 may require changes to custom configurations. The reference link to the graphql-ws changelog is a good addition.
Optionally, you might consider briefly summarizing one or two notable changes in graphql-ws v6 that require attention for easier migration.packages/transports/ws/CHANGELOG.md (2)
5-10: Major Changes – WebSocket Transport ConfigurationThis section clearly documents that only the
connectionParamscan now be configured and highlights that the underlying graphql‐ws client normally requires no further configuration. For improved readability, consider rephrasing the sentence from “In most of the cases you won't need to configure the underlying graphql-ws client any further.” to “In most cases you won't need to configure the underlying graphql-ws client any further.”Suggested diff:
- In most of the cases you won't need to configure the underlying graphql-ws client any further. + In most cases you won't need to configure the underlying graphql-ws client any further.
19-27: Patch Changes – Dependency UpdatesThis patch changes section concisely presents the dependency updates:
- Upgrading
graphql-wsto version^6.0.3- Adding the
isomorphic-wsdependency at^5.0.0- Bumping
@graphql-tools/executor-graphql-wsto2.0.0For clarity, if the multiple commit references (all pointing to
0b13cb4) are derived from the same change, consider consolidating them into a single reference.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
.changeset/@graphql-hive_gateway-481-dependencies.md(0 hunks).changeset/@graphql-hive_gateway-runtime-481-dependencies.md(0 hunks).changeset/@graphql-mesh_transport-ws-481-dependencies.md(0 hunks).changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md(0 hunks).changeset/silent-dingos-warn.md(0 hunks).changeset/six-planes-change.md(0 hunks).changeset/swift-scissors-end.md(0 hunks).changeset/tame-garlics-itch.md(0 hunks).changeset/violet-scissors-judge.md(0 hunks).changeset/warm-tigers-lie.md(0 hunks)packages/executors/graphql-ws/CHANGELOG.md(1 hunks)packages/executors/graphql-ws/package.json(1 hunks)packages/gateway/CHANGELOG.md(1 hunks)packages/gateway/package.json(1 hunks)packages/plugins/opentelemetry/CHANGELOG.md(1 hunks)packages/plugins/opentelemetry/package.json(1 hunks)packages/plugins/prometheus/CHANGELOG.md(1 hunks)packages/plugins/prometheus/package.json(1 hunks)packages/runtime/CHANGELOG.md(1 hunks)packages/runtime/package.json(1 hunks)packages/transports/ws/CHANGELOG.md(1 hunks)packages/transports/ws/package.json(1 hunks)
💤 Files with no reviewable changes (10)
- .changeset/@graphql-hive_gateway-runtime-481-dependencies.md
- .changeset/warm-tigers-lie.md
- .changeset/six-planes-change.md
- .changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md
- .changeset/silent-dingos-warn.md
- .changeset/@graphql-mesh_transport-ws-481-dependencies.md
- .changeset/tame-garlics-itch.md
- .changeset/@graphql-hive_gateway-481-dependencies.md
- .changeset/swift-scissors-end.md
- .changeset/violet-scissors-judge.md
✅ Files skipped from review due to trivial changes (7)
- packages/runtime/package.json
- packages/gateway/package.json
- packages/plugins/opentelemetry/package.json
- packages/plugins/prometheus/package.json
- packages/executors/graphql-ws/package.json
- packages/runtime/CHANGELOG.md
- packages/plugins/prometheus/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (5)
packages/plugins/opentelemetry/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/plugins/**: The directories inside this dir are gateway plugins. Plugins adds functionality to the GraphQL gateway, at the runtime level. Plugins included are authorization, authentication, caching, persisted documents and more.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/transports/ws/package.json (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/transports/**: The transports configures how to deal with HTTP requests that are made from the GraphQL gateway to the GraphQL subgraphs. Transports manipulates the HTTP calls, headers, protocols and others.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/executors/graphql-ws/CHANGELOG.md (2)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/transports/ws/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/transports/**: The transports configures how to deal with HTTP requests that are made from the GraphQL gateway to the GraphQL subgraphs. Transports manipulates the HTTP calls, headers, protocols and others.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/gateway/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/gateway/**: The main runtime for the Hive gateway.
This package is CLI that runs the gateway and configures the internals of the gateway function.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
⏰ Context from checks skipped due to timeout of 90000ms (28)
- GitHub Check: Binary built on ubuntu-24.04-arm
- GitHub Check: Binary built on macos-14
- GitHub Check: Binary built on macos-13
- GitHub Check: Binary built on ubuntu-latest
- GitHub Check: Bun Docker image
- GitHub Check: Node Docker image
- GitHub Check: E2E / Bun Docker on Ubuntu
- GitHub Check: E2E / Bun on Ubuntu
- GitHub Check: E2E / Node Binary on Windows
- GitHub Check: E2E / Node Binary on Ubuntu
- GitHub Check: E2E / Node Docker on Ubuntu
- GitHub Check: Leaks / Node v22
- GitHub Check: Leaks / Node v20
- GitHub Check: E2E / Node 22 on Ubuntu
- GitHub Check: Leaks / Node v18
- GitHub Check: E2E / Node 20 on Ubuntu
- GitHub Check: Benchmark / bun / 1000 items
- GitHub Check: E2E / Node 18 on Ubuntu
- GitHub Check: Benchmark / bun / 100 items
- GitHub Check: Unit / Bun
- GitHub Check: Benchmark / bun / 10 items
- GitHub Check: Benchmark / node / 1000 items
- GitHub Check: Benchmark / node / 100 items
- GitHub Check: Build
- GitHub Check: Unit / Node v18
- GitHub Check: Benchmark / node / 10 items
- GitHub Check: Bundle
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (16)
packages/plugins/opentelemetry/CHANGELOG.md (1)
3-9: New Version Section for 1.3.39 Added Correctly
The new section for version 1.3.39 is formatted correctly with the appropriate Markdown headers. The "### Patch Changes" subheading clearly organizes the update, and the dependency update for@graphql-hive/gateway-runtimeto version 1.4.11 is clearly listed with the associated commit link. Please confirm that this update aligns with your intended dependency bump (from 1.4.10 in 1.3.38 to 1.4.11) and that a corresponding changeset file has been generated per the repository’s guidelines.packages/executors/graphql-ws/CHANGELOG.md (4)
3-4: Version Bump to 2.0.0 — Confirm Changeset DocumentationThe changelog header now reflects the major version bump to 2.0.0, which aligns with the intended breaking changes. Please ensure that a corresponding changeset file (using
yarn changeset) is present with a detailed description of the breaking changes.
9-10: Clarification on Dependency RemovalThe explanation regarding the removal of dependency on the types is clear. It explains that further customization requires passing your own client instance. This is helpful for users migrating their configurations, so no changes are required here.
28-30: Minor Changes — Exporting GraphQLWSExecutorOptions TypeThe changelog correctly documents the export of the
GraphQLWSExecutorOptionstype. This addition aids type accessibility and consistency. The section is clear and informative.
31-38: Patch Changes — Dependency Update DetailsThe patch changes section documents the update of the
graphql-wsdependency from^5.14.0to^6.0.3. This is crucial information for users regarding dependency management.
Please verify that all peer- or transitive dependencies are compatible with graphql-ws v6 if applicable.packages/transports/ws/CHANGELOG.md (3)
3-4: Version Bump to 1.0.0The new version header is correctly added as "## 1.0.0". Please ensure that a corresponding changeset file is provided to document the release details and the semantic versioning impact.
13-18: Minor Changes – Upgrade to graphql-ws v6The minor changes entry properly indicates the upgrade to graphql-ws v6 and warns users with custom configurations to adjust accordingly. The inclusion of the link to the graphql-ws changelog is particularly helpful for migration guidance.
1-27: Overall Changelog Consistency and PR MetadataThe changelog entries are well-structured and align with the PR objectives for the upcoming release. As a reminder, please ensure that the PR description includes a reference to the associated Linear issue (e.g., a "GW-*" identifier) if applicable. This extra metadata helps with tracking release-related changes across packages.
packages/gateway/CHANGELOG.md (7)
3-4: Version Bump Confirmation for 1.9.2:
The new changelog entry header (## 1.9.2) is clearly defined and indicates the beginning of the new version release. Please ensure that a corresponding changeset file (generated viayarn changeset) exists with a full description of these updates along with examples where necessary.
5-7: Patch Changes Section Heading:
The "### Patch Changes" section is properly designated to describe non-breaking updates. The formatting and attribution (e.g., thanks to [@enisdenjo]) are consistent with previous entries.
7-10: Dependency Update forgraphql-ws:
The update from^5.16.0to^6.0.3is clearly indicated in the bullet:
- Updated dependency
graphql-ws@^6.0.3↗︎ (from^5.16.0, independencies)Make sure that any necessary migration details (if users have custom configurations) are documented in your release notes or developer documentation.
11-14: Simplification of WebSocket Transport Options:
This change explains that WebSocket transport options now allow configuring onlyconnectionParams, reducing the need to customize the underlyinggraphql-wsclient. The note, “In most of the cases you won't need to configure the underlying graphql-ws client any further,” is clear and user friendly.
15-18: Upgrade Notice forgraphql-wsto v6:
The changelog advises users that if they use a customgraphql-wsconfiguration, they must migrate to version 6. The provided link to the official changelog ofgraphql-ws(v6.0.0 release notes) is a good practice to guide users through potential breaking changes.
19-25: Summary of Other Updated Dependencies:
The consolidated list of updated dependencies is comprehensive and well-formatted. It lists the following upgrades:
- @graphql-hive/gateway-runtime@1.4.11
- @graphql-mesh/transport-ws@1.0.0
- @graphql-mesh/hmac-upstream-signature@1.2.19
- @graphql-mesh/plugin-opentelemetry@1.3.39
- @graphql-mesh/plugin-prometheus@1.3.27
Please double-check that these new versions are correctly specified in the respective package manifests and that any necessary migration guides or documentation updates have been prepared.
1-25: Missing Linear Issue Reference:
According to our guidelines, PRs should reference a Linear issue (e.g., "GW-*") to ensure proper traceability. There is no such reference in this changelog entry. Please confirm if a Linear issue should be linked in the PR description or changelog entry for comprehensive issue tracking.packages/transports/ws/package.json (1)
3-3: Major Version Bump – Validate Accompanying Documentation and ChangesetThe version change to
"1.0.0"indicates a major update with potential breaking changes. Please ensure that a corresponding changeset file has been created (usingyarn changeset) that fully documents these breaking changes and specifies the major semver bump. Additionally, verify that the related documentation (especially in theconsoleproject) is updated accordingly and that a Linear issue (e.g., one starting with "GW-") is linked in the PR description, as per the guidelines.
🚀 Snapshot Release (Bun Docker Image)The latest changes of this PR are available as image on GitHub Container Registry (based on the declared |
🚀 Snapshot Release (Node Docker Image)The latest changes of this PR are available as image on GitHub Container Registry (based on the declared |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/transports/ws/CHANGELOG.md (1)
13-18: Minor Changes Block Clarity
The update to upgradegraphql-wsto v6 is clearly documented with an advisory note for users with custom configurations. Consider briefly noting if there are any specific migration steps or breaking changes that users should be aware of (beyond consulting the graphql-ws changelog).packages/executors/graphql-ws/CHANGELOG.md (1)
5-8: Major Changes: Removal of Default graphql-ws Dependency OptionsThe bullet clearly references PR [#481] and notes the removal of default dependency options from the executor options. To improve clarity, consider rephrasing the description slightly (for example, “Executor options no longer include the default graphql-ws dependency configurations”) so that the intent is immediately clear.
packages/gateway/CHANGELOG.md (1)
11-13: WebSocket Transport Options Simplification
This entry indicates that users now only need to configureconnectionParams, simplifying the setup.Nitpick: The sentence on line 13 could be rephrased for clarity. Consider changing:
- In most of the cases you won't need to configure the underlying graphql-ws client any further. + In most cases, you won't need to configure the underlying graphql-ws client any further.This minor change improves readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...lyconnectionParamsIn most of the cases you won't need to configure the underly...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
.changeset/@graphql-hive_gateway-481-dependencies.md(0 hunks).changeset/@graphql-hive_gateway-runtime-481-dependencies.md(0 hunks).changeset/@graphql-mesh_transport-ws-481-dependencies.md(0 hunks).changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md(0 hunks).changeset/silent-dingos-warn.md(0 hunks).changeset/six-planes-change.md(0 hunks).changeset/swift-scissors-end.md(0 hunks).changeset/tame-garlics-itch.md(0 hunks).changeset/violet-scissors-judge.md(0 hunks).changeset/warm-tigers-lie.md(0 hunks)packages/executors/graphql-ws/CHANGELOG.md(1 hunks)packages/executors/graphql-ws/package.json(1 hunks)packages/gateway/CHANGELOG.md(1 hunks)packages/gateway/package.json(1 hunks)packages/plugins/opentelemetry/CHANGELOG.md(1 hunks)packages/plugins/opentelemetry/package.json(1 hunks)packages/plugins/prometheus/CHANGELOG.md(1 hunks)packages/plugins/prometheus/package.json(1 hunks)packages/runtime/CHANGELOG.md(1 hunks)packages/runtime/package.json(1 hunks)packages/transports/ws/CHANGELOG.md(1 hunks)packages/transports/ws/package.json(1 hunks)
💤 Files with no reviewable changes (10)
- .changeset/@graphql-hive_gateway-runtime-481-dependencies.md
- .changeset/tame-garlics-itch.md
- .changeset/six-planes-change.md
- .changeset/warm-tigers-lie.md
- .changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md
- .changeset/@graphql-hive_gateway-481-dependencies.md
- .changeset/violet-scissors-judge.md
- .changeset/swift-scissors-end.md
- .changeset/silent-dingos-warn.md
- .changeset/@graphql-mesh_transport-ws-481-dependencies.md
🚧 Files skipped from review as they are similar to previous changes (9)
- packages/transports/ws/package.json
- packages/runtime/package.json
- packages/executors/graphql-ws/package.json
- packages/gateway/package.json
- packages/plugins/prometheus/package.json
- packages/runtime/CHANGELOG.md
- packages/plugins/prometheus/CHANGELOG.md
- packages/plugins/opentelemetry/package.json
- packages/plugins/opentelemetry/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (3)
packages/executors/graphql-ws/CHANGELOG.md (2)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/transports/ws/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/transports/**: The transports configures how to deal with HTTP requests that are made from the GraphQL gateway to the GraphQL subgraphs. Transports manipulates the HTTP calls, headers, protocols and others.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
packages/gateway/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/gateway/**: The main runtime for the Hive gateway.
This package is CLI that runs the gateway and configures the internals of the gateway function.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
🪛 LanguageTool
packages/gateway/CHANGELOG.md
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ly connectionParams In most of the cases you won't need to configure the underly...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (25)
- GitHub Check: Binary built on ubuntu-24.04-arm
- GitHub Check: E2E / Bun Docker on Ubuntu
- GitHub Check: E2E / Bun on Ubuntu
- GitHub Check: E2E / Node Binary on Windows
- GitHub Check: E2E / Node Binary on Ubuntu
- GitHub Check: Unit / Bun
- GitHub Check: E2E / Node Docker on Ubuntu
- GitHub Check: E2E / Node 22 on Ubuntu
- GitHub Check: Leaks / Node v22
- GitHub Check: E2E / Node 20 on Ubuntu
- GitHub Check: Unit / Node v22
- GitHub Check: Leaks / Node v20
- GitHub Check: E2E / Node 18 on Ubuntu
- GitHub Check: Unit / Node v20
- GitHub Check: Leaks / Node v18
- GitHub Check: Unit / Node v18
- GitHub Check: Benchmark / bun / 1000 items
- GitHub Check: Benchmark / bun / 100 items
- GitHub Check: Benchmark / bun / 10 items
- GitHub Check: Benchmark / node / 1000 items
- GitHub Check: Bundle
- GitHub Check: Benchmark / node / 100 items
- GitHub Check: Build
- GitHub Check: Benchmark / node / 10 items
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (13)
packages/transports/ws/CHANGELOG.md (3)
3-4: Release Version Header Verification
The new version header “1.0.0” clearly indicates the release’s milestone. Please ensure that a corresponding changeset file (generated viayarn changeset) is included or referenced with a full description of the changes, as required by our guidelines.
5-12: Major Changes Block Consistency
The “Major Changes” block succinctly highlights two significant updates:
- Configuring only
connectionParamsfor WebSocket transport options- Declaring the transport as stable and production-ready
Please verify that the commit references and links are accurate and that these changes indeed represent breaking updates for users.
19-27: Patch Changes Section Detailing Dependency Updates
The “Patch Changes” segment effectively lists the dependency updates:
- Upgrading
graphql-wsfrom^5.16.0to^6.0.3- Adding
isomorphic-ws@^5.0.0- Updating
@graphql-tools/executor-graphql-wsto version2.0.0Ensure that the formatting is consistent with our overall changelog style and that all commit references are correct. If any of these dependency updates lead to non-breaking improvements or require migration notes, consider adding a clarifying sentence.
packages/executors/graphql-ws/CHANGELOG.md (5)
3-4: Version Header Update: Confirming Major Release VersionThe new version header “2.0.0” is clearly introduced here to signal a major release with breaking changes. Make sure that all downstream documentation and dependency version checks are aligned with this major bump.
9-22: Guidance & Code Example for Custom Client InstantiationThe explanatory text and corresponding code sample effectively illustrate how users should now pass their own
graphql-wsclient instance viabuildGraphQLWSExecutor. The example is well formatted and instructive. You might add inline comments in the code block for even greater clarity, but overall the guidance is solid.
24-27: Major Changes: Upgrade to graphql-ws v6This segment communicates the upgrade to graphql-ws version 6 and advises users with custom configurations to consult the graphql-ws changelog. The messaging is clear regarding the migration requirement.
28-31: Minor Changes: Export of GraphQLWSExecutorOptions TypeThe minor change that exports the
GraphQLWSExecutorOptionstype is well noted. This update will enhance type accessibility for users and is clearly documented in the changelog.
32-37: Patch Changes: Dependency Update for graphql-wsThe patch section accurately records the dependency update—from
^5.14.0to^6.0.3—and clearly provides the relevant npm link for verification. Ensure that any related configuration or documentation that references the old version is updated accordingly.packages/gateway/CHANGELOG.md (5)
3-4: Version Header Updated Correctly
The changelog now clearly marks the beginning of version 1.9.2. Please ensure that a corresponding changeset file exists with a full description of this update.
5-6: Patch Changes Section Confirmation
The header "### Patch Changes" is appropriately used to group the patch update entries for version 1.9.2.
7-10: Dependency Update forgraphql-ws
The entry documents the upgrade ofgraphql-wsfrom^5.16.0to^6.0.3with a clear reference link. This aligns well with the PR objectives. Make sure that any migration-related notes (especially for users with custom configurations) are also incorporated in the documentation or the release notes.
15-18: GraphQL-WS Upgrade Documentation
The changelog entry for upgrading graphql-ws to v6 is clear and includes a helpful link to the graphql-ws changelog for further details. Ensure that downstream users update their custom configurations if needed.
19-25: Consolidated Dependency Updates
The final block lists multiple updated dependencies (such as@graphql-hive/gateway-runtime,@graphql-mesh/transport-ws,@graphql-mesh/hmac-upstream-signature,@graphql-mesh/plugin-opentelemetry, and@graphql-mesh/plugin-prometheus) with appropriate commit references. The presentation is clear and consistent with the overall release changes.
🚀 Snapshot Release (Binary for
|
🚀 Snapshot Release (Binary for
|
229fe0d to
7759f3d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/transports/ws/CHANGELOG.md (2)
3-12: New Major Release (1.0.0) AnnouncementThis section introduces version 1.0.0 with major changes. It clearly indicates that the WebSocket transport now allows configuring only the
connectionParamsand asserts that the transport is stable and production-ready.Recommendations:
• Ensure a corresponding changeset file exists with a full description of these breaking changes and the related migration steps.
• If applicable, include links to related Linear issues (e.g., references containing “GW-*”) to improve traceability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...lyconnectionParamsIn most of the cases you won't need to configure the underly...(AI_HYDRA_LEO_MISSING_COMMA)
9-9: Nitpick: Punctuation ReviewThe description in this block reads:
"In most of the cases you won't need to configure the underlying graphql-ws client any further."
Consider revising to improve clarity. For example:
"In most cases, you won't need to configure the underlying graphql-ws client any further."
This small refinement could improve readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...lyconnectionParamsIn most of the cases you won't need to configure the underly...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
.changeset/@graphql-hive_gateway-481-dependencies.md(0 hunks).changeset/@graphql-hive_gateway-runtime-481-dependencies.md(0 hunks).changeset/@graphql-mesh_transport-ws-481-dependencies.md(0 hunks).changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md(0 hunks).changeset/silent-dingos-warn.md(0 hunks).changeset/six-planes-change.md(0 hunks).changeset/swift-scissors-end.md(0 hunks).changeset/tame-garlics-itch.md(0 hunks).changeset/violet-scissors-judge.md(0 hunks).changeset/warm-tigers-lie.md(0 hunks)packages/executors/graphql-ws/CHANGELOG.md(1 hunks)packages/executors/graphql-ws/package.json(1 hunks)packages/gateway/CHANGELOG.md(1 hunks)packages/gateway/package.json(1 hunks)packages/plugins/opentelemetry/CHANGELOG.md(1 hunks)packages/plugins/opentelemetry/package.json(1 hunks)packages/plugins/prometheus/CHANGELOG.md(1 hunks)packages/plugins/prometheus/package.json(1 hunks)packages/runtime/CHANGELOG.md(1 hunks)packages/runtime/package.json(1 hunks)packages/transports/ws/CHANGELOG.md(1 hunks)packages/transports/ws/package.json(1 hunks)
💤 Files with no reviewable changes (10)
- .changeset/silent-dingos-warn.md
- .changeset/tame-garlics-itch.md
- .changeset/swift-scissors-end.md
- .changeset/violet-scissors-judge.md
- .changeset/@graphql-mesh_transport-ws-481-dependencies.md
- .changeset/@graphql-hive_gateway-runtime-481-dependencies.md
- .changeset/@graphql-hive_gateway-481-dependencies.md
- .changeset/warm-tigers-lie.md
- .changeset/@graphql-tools_executor-graphql-ws-481-dependencies.md
- .changeset/six-planes-change.md
🚧 Files skipped from review as they are similar to previous changes (11)
- packages/runtime/package.json
- packages/plugins/opentelemetry/package.json
- packages/transports/ws/package.json
- packages/executors/graphql-ws/package.json
- packages/plugins/prometheus/package.json
- packages/gateway/package.json
- packages/plugins/opentelemetry/CHANGELOG.md
- packages/runtime/CHANGELOG.md
- packages/executors/graphql-ws/CHANGELOG.md
- packages/gateway/CHANGELOG.md
- packages/plugins/prometheus/CHANGELOG.md
🧰 Additional context used
📓 Path-based instructions (1)
packages/transports/ws/CHANGELOG.md (3)
Pattern packages/**: In this directory we keep all packages relevant to the gateway.
In most cases, when changes are made to the source code / dependencies in these directories, we also require to have a corresponding changeset file, created using yarn changeset with a full description on the changes with an example.
Also, when new features are added the packages, the changeset file should mention minor semver change. When a bug is fixed, patch needs to be used. The major bump is used for a PR that has breaking changes.
Pattern packages/transports/**: The transports configures how to deal with HTTP requests that are made from the GraphQL gateway to the GraphQL subgraphs. Transports manipulates the HTTP calls, headers, protocols and others.
Pattern **: For all PRs, we would like to verify that a Linear issue is linked. Check if there's a mention for "GW-*" in the PR description, and the us know when it's missing.
In most cases, when a PR adds a new functionality, we would like to make sure it has documentation in the corresponding console project.
Use the global knowledge feature to search for PRs in graphql-hive/console repository that adds documentation. Suggest to create a follow up issue to add the missing documentation.
🪛 LanguageTool
packages/transports/ws/CHANGELOG.md
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...ly connectionParams In most of the cases you won't need to configure the underly...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (22)
- GitHub Check: Binary built on ubuntu-latest
- GitHub Check: E2E / Bun Docker on Ubuntu
- GitHub Check: E2E / Bun on Ubuntu
- GitHub Check: E2E / Node Binary on Windows
- GitHub Check: E2E / Node Binary on Ubuntu
- GitHub Check: E2E / Node Docker on Ubuntu
- GitHub Check: E2E / Node 22 on Ubuntu
- GitHub Check: Unit / Bun
- GitHub Check: Benchmark / bun / 1000 items
- GitHub Check: E2E / Node 20 on Ubuntu
- GitHub Check: Benchmark / bun / 100 items
- GitHub Check: Benchmark / bun / 10 items
- GitHub Check: Leaks / Node v22
- GitHub Check: Benchmark / node / 1000 items
- GitHub Check: Leaks / Node v20
- GitHub Check: Benchmark / node / 100 items
- GitHub Check: Bundle
- GitHub Check: E2E / Node 18 on Ubuntu
- GitHub Check: Benchmark / node / 10 items
- GitHub Check: Build
- GitHub Check: Leaks / Node v18
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
packages/transports/ws/CHANGELOG.md (2)
13-18: Minor Changes: Upgrade to graphql-ws v6The minor changes section indicates that users with custom configurations must migrate their graphql-ws setup to v6, and it provides a link to the graphql-ws changelog for further guidance.
Recommendation:
Ensure that any accompanying documentation or migration guides (possibly in the console project or repository docs) are updated to reflect these changes.
19-28: Patch Changes: Dependency UpdatesThe patch section details important dependency updates:
• Upgradinggraphql-wsfrom^5.16.0to^6.0.3.
• Addingisomorphic-ws@^5.0.0.
• Updating@graphql-tools/executor-graphql-wsto version2.0.0.Recommendation:
Verify that these dependency updates have been tested in integration and that any potential compatibility issues are documented in the release notes or changeset file.
This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.
Releases
@graphql-tools/executor-graphql-ws@2.0.0
Major Changes
#481
0b13cb4Thanks @enisdenjo! - Executor options don't exist graphql-ws dependency optionsRemoving the dependency on the types. Some options are still exposed, but if you want to further customise the graphql-ws client, you should pass your own instance of the client instead.
#481
0b13cb4Thanks @enisdenjo! - Upgrade graphql-ws to v6If you have a custom graphql-ws configuration when building the executor with
buildGraphQLWSExecutor, you will have to migrate the graphql-ws side to v6. Please consult the changelog of graphql-ws.Minor Changes
0b13cb4Thanks @enisdenjo! - Export GraphQLWSExecutorOptions typePatch Changes
#481
0b13cb4Thanks @enisdenjo! - dependencies updates:graphql-ws@^6.0.3↗︎ (from^5.14.0, independencies)@graphql-mesh/transport-ws@1.0.0
Major Changes
#481
0b13cb4Thanks @enisdenjo! - WebSocket transport options allow configuring onlyconnectionParamsIn most of the cases you won't need to configure the underlying graphql-ws client any further.
#481
0b13cb4Thanks @enisdenjo! - WebSocket transport is stable and production readyMinor Changes
#481
0b13cb4Thanks @enisdenjo! - Upgrade graphql-ws to v6If you have a custom graphql-ws configuration when using the transport, you will have to migrate the graphql-ws side to v6. Please consult the changelog of graphql-ws.
Patch Changes
#481
0b13cb4Thanks @enisdenjo! - dependencies updates:graphql-ws@^6.0.3↗︎ (from^5.16.0, independencies)isomorphic-ws@^5.0.0↗︎ (todependencies)Updated dependencies [
0b13cb4,0b13cb4,0b13cb4,0b13cb4]:@graphql-hive/gateway@1.9.2
Patch Changes
#481
0b13cb4Thanks @enisdenjo! - dependencies updates:graphql-ws@^6.0.3↗︎ (from^5.16.0, independencies)#481
0b13cb4Thanks @enisdenjo! - WebSocket transport options allow configuring onlyconnectionParamsIn most of the cases you won't need to configure the underlying graphql-ws client any further.
#481
0b13cb4Thanks @enisdenjo! - Upgrade graphql-ws to v6If you have a custom graphql-ws configuration when using the transport, you will have to migrate the graphql-ws side to v6. Please consult the changelog of graphql-ws.
Updated dependencies [
0b13cb4,0b13cb4,0b13cb4,0b13cb4,0b13cb4]:@graphql-mesh/plugin-opentelemetry@1.3.39
Patch Changes
0b13cb4]:@graphql-mesh/plugin-prometheus@1.3.27
Patch Changes
0b13cb4]:@graphql-hive/gateway-runtime@1.4.11
Patch Changes
#481
0b13cb4Thanks @enisdenjo! - dependencies updates:graphql-ws@^6.0.3↗︎ (from^5.16.0, independencies)Updated dependencies []: