Skip to content

[Snyk] Upgrade @apollo/client from 3.7.17 to 3.13.0 #1803

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.

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

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

X-oss-byte
Copy link
Owner

@X-oss-byte X-oss-byte commented Mar 6, 2025

snyk-top-banner

Snyk has created this PR to upgrade @apollo/client from 3.7.17 to 3.13.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.


  • The recommended version is 107 versions ahead of your current version.

  • The recommended version was released 21 days ago.

Release notes
Package name: @apollo/client
  • 3.13.0 - 2025-02-13

    Apollo Client v3.13.0 introduces a new hook, useSuspenseFragment, as a drop-in replacement for useFragment in apps that are using React Suspense. This is the “last” React hook we are introducing in 3.x - we think this rounds out the “big concepts” in our React Suspense and GraphQL fragment story. See the docs for information on this and our other Suspense-supporting hooks. There are some TypeScript quality-of-life improvements shipped in this release for observableQuery.updateQuery and subscribeToMore. Additionally, the return type of updateQuery now includes undefined to allow an early exit from updates. This was always supported at runtime, but was missed on the TypeScript side. On the runtime side, we’ve fixed query deduplication behavior for multipart responses and corrected the error handling in useMutation callbacks. onCompleted and onError in useQuery and useLazyQuery have been deprecated for multiple reasons. See below for full details 👀

    Minor Changes

    • #12066 c01da5d Thanks @ jerelmiller! - Adds a new useSuspenseFragment hook.

      useSuspenseFragment suspends until data is complete. It is a drop-in replacement for useFragment when you prefer to use Suspense to control the loading state of a fragment. See the documentation for more details.

    • #12174 ba5cc33 Thanks @ jerelmiller! - Ensure errors thrown in the onCompleted callback from useMutation don't call onError.

    • #12340 716d02e Thanks @ phryneas! - Deprecate the onCompleted and onError callbacks of useQuery and useLazyQuery.
      For more context, please see the related issue on GitHub.

    • #12276 670f112 Thanks @ Cellule! - Provide a more type-safe option for the previous data value passed to observableQuery.updateQuery. Using it could result in crashes at runtime as this callback could be called with partial data even though its type reported the value as a complete result.

      The updateQuery callback function is now called with a new type-safe previousData property and a new complete property in the 2nd argument that determines whether previousData is a complete or partial result.

      As a result of this change, it is recommended to use the previousData property passed to the 2nd argument of the callback rather than using the previous data value from the first argument since that value is not type-safe. The first argument is now deprecated and will be removed in a future version of Apollo Client.

      observableQuery.updateQuery(
      (unsafePreviousData, { previousData, complete }) => {
      previousData;
      // ^? TData | DeepPartial<TData> | undefined

      <span class="pl-k">if</span> <span class="pl-kos">(</span><span class="pl-s1">complete</span><span class="pl-kos">)</span> <span class="pl-kos">{</span>
        <span class="pl-s1">previousData</span><span class="pl-kos">;</span>
        <span class="pl-c">// ^? TData</span>
      <span class="pl-kos">}</span> <span class="pl-k">else</span> <span class="pl-kos">{</span>
        <span class="pl-s1">previousData</span><span class="pl-kos">;</span>
        <span class="pl-c">// ^? DeepPartial&lt;TData&gt; | undefined</span>
      <span class="pl-kos">}</span>
      

      }
      );

    • #12174 ba5cc33 Thanks @ jerelmiller! - Reject the mutation promise if errors are thrown in the onCompleted callback of useMutation.

    Patch Changes

    • #12276 670f112 Thanks @ Cellule! - Fix the return type of the updateQuery function to allow for undefined. updateQuery had the ability to bail out of the update by returning a falsey value, but the return type enforced a query value.

      observableQuery.updateQuery(
      (unsafePreviousData, { previousData, complete }) => {
      if (!complete) {
      // Bail out of the update by returning early
      return;
      }

      <span class="pl-c">// ...</span>
      

      }
      );

    • #12296 2422df2 Thanks @ Cellule! - Deprecate option ignoreResults in useMutation.
      Once this option is removed, existing code still using it might see increase in re-renders.
      If you don't want to synchronize your component state with the mutation, please use useApolloClient to get your ApolloClient instance and call client.mutate directly.

    • #12338 67c16c9 Thanks @ phryneas! - In case of a multipart response (e.g. with @ defer), query deduplication will
      now keep going until the final chunk has been received.

    • #12276 670f112 Thanks @ Cellule! - Fix the type of the variables property passed as the 2nd argument to the subscribeToMore callback. This was previously reported as the variables type for the subscription itself, but is now properly typed as the query variables.

  • 3.13.0-rc.0 - 2025-02-07

    Minor Changes

    • #12066 c01da5d Thanks @ jerelmiller! - Adds a new useSuspenseFragment hook.

      useSuspenseFragment suspends until data is complete. It is a drop-in replacement for useFragment when you prefer to use Suspense to control the loading state of a fragment.

    • #12174 ba5cc33 Thanks @ jerelmiller! - Ensure errors thrown in the onCompleted callback from useMutation don't call onError.

    • #12340 716d02e Thanks @ phryneas! - Deprecate the onCompleted and onError callbacks of useQuery and useLazyQuery.
      For more context, please see the related issue on GitHub.

    • #12276 670f112 Thanks @ Cellule! - Provide a more type-safe option for the previous data value passed to observableQuery.updateQuery. Using it could result in crashes at runtime as this callback could be called with partial data even though its type reported the value as a complete result.

      The updateQuery callback function is now called with a new type-safe previousData property and a new complete property in the 2nd argument that determines whether previousData is a complete or partial result.

      As a result of this change, it is recommended to use the previousData property passed to the 2nd argument of the callback rather than using the previous data value from the first argument since that value is not type-safe. The first argument is now deprecated and will be removed in a future version of Apollo Client.

      observableQuery.updateQuery(
      (unsafePreviousData, { previousData, complete }) => {
      previousData;
      // ^? TData | DeepPartial<TData> | undefined

      <span class="pl-k">if</span> <span class="pl-kos">(</span><span class="pl-s1">complete</span><span class="pl-kos">)</span> <span class="pl-kos">{</span>
        <span class="pl-s1">previousData</span><span class="pl-kos">;</span>
        <span class="pl-c">// ^? TData</span>
      <span class="pl-kos">}</span> <span class="pl-k">else</span> <span class="pl-kos">{</span>
        <span class="pl-s1">previousData</span><span class="pl-kos">;</span>
        <span class="pl-c">// ^? DeepPartial&lt;TData&gt; | undefined</span>
      <span class="pl-kos">}</span>
      

      }
      );

    • #12174 ba5cc33 Thanks @ jerelmiller! - Reject the mutation promise if errors are thrown in the onCompleted callback of useMutation.

    Patch Changes

    • #12276 670f112 Thanks @ Cellule! - Fix the return type of the updateQuery function to allow for undefined. updateQuery had the ability to bail out of the update by returning a falsey value, but the return type enforced a query value.

      observableQuery.updateQuery(
      (unsafePreviousData, { previousData, complete }) => {
      if (!complete) {
      // Bail out of the update by returning early
      return;
      }

      <span class="pl-c">// ...</span>
      

      }
      );

    • #12296 2422df2 Thanks @ Cellule! - Deprecate option ignoreResults in useMutation.
      Once this option is removed, existing code still using it might see increase in re-renders.
      If you don't want to synchronize your component state with the mutation, please use useApolloClient to get your ApolloClient instance and call client.mutate directly.

    • #12338 67c16c9 Thanks @ phryneas! - In case of a multipart response (e.g. with @ defer), query deduplication will
      now keep going until the final chunk has been received.

    • #12276 670f112 Thanks @ Cellule! - Fix the type of the variables property passed as the 2nd argument to the subscribeToMore updateQuery callback. This was previously reported as the variables type for the subscription itself, but is now properly typed as the query variables.

  • 3.12.11 - 2025-02-07

    Patch Changes

    • #12351 3da908b Thanks @ jerelmiller! - Fixes an issue where the wrong networkStatus and loading value was emitted from observableQuery when calling fetchMore with a no-cache fetch policy. The networkStatus now properly reports as ready and loading as false after the result is returned.

    • #12354 a24ef94 Thanks @ phryneas! - Fix missing main.d.cts file

  • 3.12.10 - 2025-02-06

    Patch Changes

  • 3.12.9 - 2025-02-03

    Patch Changes

    • #12321 daa4f33 Thanks @ jerelmiller! - Fix type of extensions in protocolErrors for ApolloError and the onError link. According to the multipart HTTP subscription protocol, fatal tranport errors follow the GraphQL error format which require extensions to be a map as its value instead of an array.

    • #12318 b17968b Thanks @ jerelmiller! - Allow RetryLink to retry an operation when fatal transport-level errors are emitted from multipart subscriptions.

      const retryLink = new RetryLink({
      attempts: (count, operation, error) => {
      if (error instanceof ApolloError) {
      // errors available on the protocolErrors field in ApolloError
      console.log(error.protocolErrors);
      }

      <span class="pl-k">return</span> <span class="pl-c1">true</span><span class="pl-kos">;</span>
      

      },
      });

  • 3.12.8 - 2025-01-27

    Patch Changes

    • #12292 3abd944 Thanks @ phryneas! - Remove unused dependency response-iterator

    • #12287 bf313a3 Thanks @ phryneas! - Fixes an issue where client.watchFragment/useFragment with @ includes crashes when a separate cache update writes to the conditionally included fields.

  • 3.12.7 - 2025-01-22

    Patch Changes

    • #12281 d638ec3 Thanks @ jerelmiller! - Make fatal tranport-level errors from multipart subscriptions available to the error link with the protocolErrors property.

      const errorLink = onError(({ protocolErrors }) => {
        if (protocolErrors) {
          console.log(protocolErrors);
        }
      });
    • #12281 d638ec3 Thanks @ jerelmiller! - Fix the array type for the errors field on the ApolloPayloadResult type. This type was always in the shape of the GraphQL error format, per the multipart subscriptions protocol and never a plain string or a JavaScript error object.

  • 3.12.6 - 2025-01-14

    Patch Changes

    • #12267 d57429d Thanks @ jerelmiller! - Maintain the TData type when used with Unmasked when TData is not a masked type generated from GraphQL Codegen.

    • #12270 3601246 Thanks @ jerelmiller! - Fix handling of tagged/branded primitive types when used as scalar values with Unmasked.

  • 3.12.5 - 2025-01-09

    Patch Changes

    • #12252 cb9cd4e Thanks @ jerelmiller! - Changes the default behavior of the MaybeMasked type to preserve types unless otherwise specified. This change makes it easier to upgrade from older versions of the client where types could have unexpectedly changed in the application due to the default of trying to unwrap types into unmasked types. This change also fixes the compilation performance regression experienced when simply upgrading the client since types are now preserved by default.

      A new mode option has now been introduced to allow for the old behavior. See the next section on migrating if you wish to maintain the old default behavior after upgrading to this version.

      Migrating from <= v3.12.4

      If you've adopted data masking and have opted in to using masked types by setting the enabled property to true, you can remove this configuration entirely:

      -declare module "@ apollo/client" {
      -  interface DataMasking {
      -    mode: "unmask"
      -  }
      -}

      If you prefer to specify the behavior explicitly, change the property from enabled: true, to mode: "preserveTypes":

      declare module "@ apollo/client" {
        interface DataMasking {
      -    enabled: true
      +    mode: "preserveTypes"
        }
      }

      If you rely on the default behavior in 3.12.4 or below and would like to continue to use unmasked types by default, set the mode to unmask:

      declare module "@ apollo/client" {
        interface DataMasking {
          mode: "unmask";
        }
      }
  • 3.12.4 - 2024-12-19

    Patch Changes

    • #12236 4334d30 Thanks @ charpeni! - Fix an issue with refetchQueries where comparing DocumentNodes internally by references could lead to an unknown query, even though the DocumentNode was indeed an active query—with a different reference.
  • 3.12.3 - 2024-12-12
  • 3.12.2 - 2024-12-05
  • 3.12.1 - 2024-12-05
  • 3.12.0 - 2024-12-04
  • 3.12.0-rc.4 - 2024-11-27
  • 3.12.0-rc.3 - 2024-11-20
  • 3.12.0-rc.2 - 2024-11-19
  • 3.12.0-rc.1 - 2024-11-15
  • 3.12.0-rc.0 - 2024-11-13
  • 3.12.0-alpha.0 - 2024-10-01
  • 3.11.11-rc.0 - 2024-11-13
  • 3.11.10 - 2024-11-11
  • 3.11.9 - 2024-11-07
  • 3.11.8 - 2024-09-05
  • 3.11.7 - 2024-09-04
  • 3.11.6 - 2024-09-03
  • 3.11.5 - 2024-08-28
  • 3.11.4 - 2024-08-07
  • 3.11.3 - 2024-08-05
  • 3.11.2 - 2024-07-31
  • 3.11.1 - 2024-07-23
  • 3.11.0 - 2024-07-22
  • 3.11.0-rc.2 - 2024-07-15
  • 3.11.0-rc.1 - 2024-07-10
  • 3.11.0-rc.0 - 2024-07-09
  • 3.10.8 - 2024-06-27
  • 3.10.7 - 2024-06-26
  • 3.10.6 - 2024-06-21
  • 3.10.5 - 2024-06-12
  • 3.10.4 - 2024-05-15
  • 3.10.3 - 2024-05-07
  • 3.10.2 - 2024-05-03
  • 3.10.1 - 2024-04-24
  • 3.10.0 - 2024-04-24
  • 3.10.0-rc.1 - 2024-04-15
  • 3.10.0-rc.0 - 2024-04-02
  • 3.10.0-alpha.1 - 2024-03-18
  • 3.9.11 - 2024-04-10
  • 3.9.10 - 2024-04-01
  • 3.9.9 - 2024-03-22
  • 3.9.8 - 2024-03-20
  • 3.9.7 - 2024-03-13
  • 3.9.6 - 2024-03-06
  • 3.9.5 - 2024-02-15
  • 3.9.4 - 2024-02-07
  • 3.9.3 - 2024-02-06
  • 3.9.2 - 2024-02-01
  • 3.9.1 - 2024-01-31
  • 3.9.0 - 2024-01-30
  • 3.9.0-rc.1 - 2024-01-18
  • 3.9.0-rc.0 - 2024-01-17
  • 3.9.0-beta.1 - 2023-12-21
  • 3.9.0-beta.0 - 2023-12-18
  • 3.9.0-alpha.5 - 2023-12-05
  • 3.9.0-alpha.4 - 2023-11-08
  • 3.9.0-alpha.3 - 2023-11-02
  • 3.9.0-alpha.2 - 2023-10-11
  • 3.9.0-alpha.1 - 2023-09-21
  • 3.9.0-alpha.0 - 2023-09-19
  • 3.8.10 - 2024-01-18
  • 3.8.9 - 2024-01-09
  • 3.8.8 - 2023-11-29
  • 3.8.7 - 2023-11-02
  • 3.8.6 - 2023-10-16
  • 3.8.5 - 2023-10-05
  • 3.8.4 - 2023-09-19
  • 3.8.3 - 2023-09-05
  • 3.8.2 - 2023-09-01
  • 3.8.1 - 2023-08-10
  • 3.8.0 - 2023-08-07
  • 3.8.0-rc.2 - 2023-08-01
  • 3.8.0-rc.1 - 2023-07-17
  • 3.8.0-rc.0 - 2023-07-13
  • 3.8.0-beta.7 - 2023-07-10
  • 3.8.0-beta.6 - 2023-07-05
  • 3.8.0-beta.5 - 2023-06-28
  • 3.8.0-beta.4 - 2023-06-20
  • 3.8.0-beta.3 - 2023-06-15
  • 3.8.0-beta.2 - 2023-06-07
  • 3.8.0-beta.1 - 2023-05-31
  • 3.8.0-beta.0 - 2023-05-26
  • 3.8.0-alpha.15 - 2023-05-17
  • 3.8.0-alpha.14 - 2023-05-16
  • 3.8.0-alpha.13 - 2023-05-03
  • 3.8.0-alpha.12 - 2023-04-13
  • 3.8.0-alpha.11 - 2023-03-28
  • 3.8.0-alpha.10 - 2023-03-17
  • 3.8.0-alpha.9 - 2023-03-15
  • 3.8.0-alpha.8 - 2023-03-02
  • 3.8.0-alpha.7 - 2023-02-15
  • 3.8.0-alpha.6 - 2023-02-07
  • 3.8.0-alpha.5 - 2023-01-19
  • 3.8.0-alpha.4 - 2023-01-13
  • 3.8.0-alpha.3 - 2023-01-03
  • 3.8.0-alpha.2 - 2022-12-21
  • 3.8.0-alpha.1 - 2022-12-21
  • 3.8.0-alpha.0 - 2022-12-09
  • 3.7.17 - 2023-07-05
from @apollo/client GitHub release notes

Important

  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

Summary by Sourcery

Chores:

  • Update @apollo/client dependency from version 3.7.17 to 3.13.0.

Snyk has created this PR to upgrade @apollo/client from 3.7.17 to 3.13.0.

See this package in npm:
@apollo/client

See this project in Snyk:
https://app.snyk.io/org/sammytezzy/project/7d3fe4c1-0ac4-4437-b919-3a5377398eb8?utm_source=github&utm_medium=referral&page=upgrade-pr
Copy link

vercel bot commented Mar 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
next-js-next-plugin-storybook ❌ Failed (Inspect) Mar 6, 2025 7:56pm
next-js-next-plugin-storybook-g5dx ❌ Failed (Inspect) Mar 6, 2025 7:56pm
next-js-next-plugin-storybook-y5ka ❌ Failed (Inspect) Mar 6, 2025 7:56pm
next-x-storybook ❌ Failed (Inspect) Mar 6, 2025 7:56pm

Copy link

vercel bot commented Mar 6, 2025

Deployment failed with the following error:

Could not parse File as JSON: vercel.json

Copy link

stackblitz bot commented Mar 6, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Mar 6, 2025

⚠️ No Changeset found

Latest commit: 31e0e13

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.

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

Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request upgrades the @apollo/client package from version 3.7.17 to 3.13.0. The upgrade includes a new useSuspenseFragment hook, improved error handling in useMutation callbacks, deprecation of onCompleted and onError callbacks in useQuery and useLazyQuery, and several bug fixes and type improvements.

Sequence diagram for useMutation error handling

sequenceDiagram
    participant Component
    participant useMutation
    participant onCompleted Callback
    participant onError Callback

    Component->>useMutation: Call mutation
    useMutation->>onCompleted Callback: Success
    activate onCompleted Callback
    onCompleted Callback-->>useMutation: Throw Error
    deactivate onCompleted Callback
    useMutation->>useMutation: Reject mutation promise
    useMutation-->>Component: Error
Loading

File-Level Changes

Change Details Files
The pull request upgrades the @apollo/client package from version 3.7.17 to 3.13.0.
  • Upgraded @apollo/client to version 3.13.0.
examples/with-apollo/package.json
Introduces a new useSuspenseFragment hook for React Suspense.
  • Adds useSuspenseFragment hook as a drop-in replacement for useFragment in apps using React Suspense.
Improves error handling in useMutation callbacks.
  • Ensures errors thrown in the onCompleted callback from useMutation don't call onError.
  • Rejects the mutation promise if errors are thrown in the onCompleted callback of useMutation.
Deprecates onCompleted and onError callbacks of useQuery and useLazyQuery.
  • Deprecates the onCompleted and onError callbacks of useQuery and useLazyQuery.
Provides a more type-safe option for the previous data value passed to observableQuery.updateQuery.
  • Introduces a new type-safe previousData property and a complete property in the 2nd argument of the updateQuery callback.
  • Recommends using the previousData property passed to the 2nd argument of the callback instead of the previous data value from the first argument.
  • Deprecates the first argument of the updateQuery callback.
Fixes the return type of the updateQuery function to allow for undefined.
  • Allows updateQuery to bail out of the update by returning a falsey value.
Deprecates the ignoreResults option in useMutation.
  • Deprecates option ignoreResults in useMutation.
  • Suggests using useApolloClient and calling client.mutate directly if you don't want to synchronize your component state with the mutation.
Improves query deduplication behavior for multipart responses.
  • Ensures query deduplication continues until the final chunk has been received in case of a multipart response.
Fixes the type of the variables property passed as the 2nd argument to the subscribeToMore callback.
  • Correctly types the variables property in the subscribeToMore callback as the query variables.
Fixes an issue where the wrong networkStatus and loading value was emitted from observableQuery when calling fetchMore with a no-cache fetch policy.
  • The networkStatus now properly reports as ready and loading as false after the result is returned.
Fixes a "hook order" warning that might be emitted in React 19 dev mode when using useReadQuery or useQueryRefHandlers.
  • Fixes a "hook order" warning that might be emitted in React 19 dev mode.
Adds graphql-ws ^6.0.3 as a valid peerDependency.
  • Adds graphql-ws ^6.0.3 as a valid peerDependency
Fixes type of extensions in protocolErrors for ApolloError and the onError link.
  • Requires extensions to be a map as its value instead of an array.
Allows RetryLink to retry an operation when fatal transport-level errors are emitted from multipart subscriptions.
  • Allows RetryLink to retry an operation when fatal transport-level errors are emitted from multipart subscriptions.
Removes unused dependency response-iterator.
  • Removes unused dependency response-iterator
Fixes an issue where client.watchFragment or useFragment with @ includes crashes when a separate cache update writes to the conditionally included fields.
  • Fixes an issue where client.watchFragment or useFragment with @ includes crashes when a separate cache update writes to the conditionally included fields.
Makes fatal transport-level errors from multipart subscriptions available to the error link with the protocolErrors property.
  • Makes fatal transport-level errors from multipart subscriptions available to the error link with the protocolErrors property.
Fixes the array type for the errors field on the ApolloPayloadResult type.
  • The type is now in the shape of the GraphQL error format, per the multipart subscriptions protocol.
Maintains the TData type when used with Unmasked when TData is not a masked type generated from GraphQL Codegen.
  • Maintains the TData type when used with Unmasked when TData is not a masked type generated from GraphQL Codegen.
Fixes handling of tagged/branded primitive types when used as scalar values with Unmasked.
  • Fixes handling of tagged/branded primitive types when used as scalar values with Unmasked.
Changes the default behavior of the MaybeMasked type to preserve types unless otherwise specified.
  • Changes the default behavior of the MaybeMasked type to preserve types unless otherwise specified.
  • Introduces a new mode option to allow for the old behavior.
  • Provides migration steps from <= v3.12.4.
Fixes an issue with refetchQueries where comparing DocumentNodes internally by references could lead to an unknown query.
  • Fixes an issue with refetchQueries where comparing DocumentNodes internally by references could lead to an unknown query.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot ('[Snyk]' found in title). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants