Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: apollographql/apollo-client
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 6ca525a6e2e520ea67cfbfd8df0ac48988b4abe4
Choose a base ref
...
head repository: apollographql/apollo-client
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 894ae488dcb13b927c2a0a25cee527a230c61f14
Choose a head ref
Loading
Showing with 34,803 additions and 31,607 deletions.
  1. +8 −0 .changeset/README.md
  2. +14 −0 .changeset/config.json
  3. +13 −32 .circleci/config.yml
  4. +21 −0 .eslintrc
  5. +2 −0 .git-blame-ignore-revs
  6. +0 −38 .github/ISSUE_TEMPLATE/bug.md
  7. +24 −0 .github/ISSUE_TEMPLATE/bug.yml
  8. +1 −0 .github/ISSUE_TEMPLATE/question-discussion.md
  9. +1 −0 .github/PULL_REQUEST_TEMPLATE.md
  10. +179 −0 .github/workflows/close-stale-issues.yml
  11. +19 −0 .github/workflows/docs-publish.yml
  12. +59 −0 .github/workflows/exit-prerelease.yml
  13. +31 −0 .github/workflows/lock.yml
  14. +116 −0 .github/workflows/prerelease.yml
  15. +101 −0 .github/workflows/release.yml
  16. +90 −0 .github/workflows/snapshot-release.yml
  17. +7 −1 .gitignore
  18. +1 −0 .npmrc
  19. +6 −0 .prettierignore
  20. +9 −0 .vscode/launch.json
  21. +1 −1 .vscode/settings.json
  22. +537 −181 CHANGELOG.md
  23. +19 −6 CONTRIBUTING.md
  24. +1 −1 LICENSE
  25. +13 −8 README.md
  26. +37 −12 ROADMAP.md
  27. +26 −0 config/bundlesize.ts
  28. +3 −2 config/helpers.ts
  29. +72 −17 config/jest.config.js
  30. +41 −0 config/prepareChangesetsRelease.ts
  31. +1 −1 config/rewriteSourceMaps.ts
  32. +26 −11 config/rollup.config.js
  33. +0 −2 docs/.gitignore
  34. +1 −11 docs/README.md
  35. +0 −120 docs/gatsby-config.js
  36. +0 −19,502 docs/package-lock.json
  37. +0 −19 docs/package.json
  38. +1 −1 docs/shared/link-chain.mdx
  39. +9 −9 docs/shared/mutation-options.mdx
  40. +4 −1 docs/shared/mutation-result.mdx
  41. +5 −22 docs/shared/query-options.mdx
  42. +7 −7 docs/shared/query-result.mdx
  43. +1 −1 docs/shared/refetchQueries-options.mdx
  44. +8 −3 docs/shared/subscription-options.mdx
  45. +137 −0 docs/shared/useFragment-options.mdx
  46. +69 −0 docs/shared/useFragment-result.mdx
  47. +178 −0 docs/shared/useSuspenseQuery-options.mdx
  48. +139 −0 docs/shared/useSuspenseQuery-result.mdx
  49. 0 docs/{static → source}/_redirects
  50. +33 −30 docs/source/api/cache/InMemoryCache.mdx
  51. +20 −6 docs/source/api/core/ApolloClient.mdx
  52. +0 −2 docs/source/api/core/ObservableQuery.mdx
  53. +20 −4 docs/source/api/link/apollo-link-batch-http.mdx
  54. +0 −1 docs/source/api/link/apollo-link-context.md
  55. +0 −13 docs/source/api/link/apollo-link-error.md
  56. +31 −3 docs/source/api/link/apollo-link-http.md
  57. +23 −21 docs/source/api/link/apollo-link-rest.md
  58. +0 −1 docs/source/api/link/apollo-link-retry.md
  59. +1 −2 docs/source/api/link/apollo-link-schema.md
  60. +8 −7 docs/source/api/link/apollo-link-subscriptions.md
  61. +9 −12 docs/source/api/link/apollo-link-ws.md
  62. +3 −0 docs/source/api/link/community-links.md
  63. +30 −7 docs/source/api/link/introduction.mdx
  64. +1 −2 docs/source/api/link/persisted-queries.md
  65. +1 −2 docs/source/api/react/components.mdx
  66. +1 −2 docs/source/api/react/hoc.mdx
  67. +172 −0 docs/source/api/react/hooks-experimental.mdx
  68. +32 −9 docs/source/api/react/hooks.mdx
  69. +17 −1 docs/source/api/react/testing.md
  70. +91 −32 docs/source/caching/advanced-topics.mdx
  71. +22 −28 docs/source/caching/cache-configuration.mdx
  72. +213 −119 docs/source/caching/{cache-field-behavior.md → cache-field-behavior.mdx}
  73. +27 −19 docs/source/caching/cache-interaction.mdx
  74. +2 −3 docs/source/caching/garbage-collection.mdx
  75. +23 −25 docs/source/caching/overview.mdx
  76. +101 −0 docs/source/config.json
  77. +83 −0 docs/source/data/defer.mdx
  78. +40 −37 docs/source/data/error-handling.mdx
  79. +27 −0 docs/source/data/file-uploads.md
  80. +9 −5 docs/source/data/fragments.md
  81. +19 −20 docs/source/data/mutations.mdx
  82. +10 −13 docs/source/data/operation-best-practices.mdx
  83. +148 −35 docs/source/data/queries.mdx
  84. +1 −2 docs/source/data/refetching.mdx
  85. +49 −33 docs/source/data/subscriptions.mdx
  86. +11 −11 docs/source/development-testing/client-schema-mocking.mdx
  87. +5 −156 docs/source/development-testing/developer-tooling.md
  88. +290 −163 docs/source/development-testing/static-typing.md
  89. +145 −158 docs/source/development-testing/testing.mdx
  90. +95 −85 docs/source/get-started.mdx
  91. +9 −11 docs/source/index.mdx
  92. +4 −1 docs/source/integrations/integrations.md
  93. +1 −1 docs/source/local-state/client-side-schema.mdx
  94. +7 −7 docs/source/local-state/local-resolvers.mdx
  95. +5 −6 docs/source/local-state/local-state-management.mdx
  96. +53 −22 docs/source/local-state/managing-state-with-field-policies.mdx
  97. +23 −4 docs/source/local-state/reactive-variables.mdx
  98. +9 −5 docs/source/migrating/apollo-client-3-migration.mdx
  99. +8 −5 docs/source/networking/advanced-http-networking.md
  100. +27 −1 docs/source/networking/authentication.mdx
  101. +5 −6 docs/source/pagination/core-api.mdx
  102. +2 −2 docs/source/pagination/cursor-based.mdx
  103. +292 −40 docs/source/pagination/key-args.mdx
  104. +5 −6 docs/source/pagination/offset-based.mdx
  105. +0 −1 docs/source/pagination/overview.mdx
  106. +15 −0 docs/source/performance/babel.md
  107. +2 −2 docs/source/performance/optimistic-ui.mdx
  108. +1 −6 docs/source/performance/performance.mdx
  109. +8 −12 docs/source/performance/server-side-rendering.mdx
  110. +86 −49 docs/source/why-apollo.mdx
  111. +17 −11 netlify.toml
  112. +10,101 −4,136 package-lock.json
  113. +76 −55 package.json
  114. +63 −0 patches/@testing-library+react-12+12.1.5.patch
  115. +9 −14 renovate.json
  116. +1 −1 scripts/codemods/ac2-to-ac3/package.json
  117. +3 −4 scripts/memory/package.json
  118. +67 −1 src/__tests__/ApolloClient.ts
  119. +18 −2 src/__tests__/__snapshots__/exports.ts.snap
  120. +2 −2 src/__tests__/__snapshots__/graphqlSubscriptions.ts.snap
  121. +111 −5 src/__tests__/client.ts
  122. +5 −0 src/__tests__/exports.ts
  123. +914 −210 src/__tests__/fetchMore.ts
  124. +56 −17 src/__tests__/graphqlSubscriptions.ts
  125. +148 −1 src/__tests__/local-state/general.ts
  126. +112 −1 src/__tests__/local-state/resolvers.ts
  127. +8 −6 src/cache/core/cache.ts
  128. +2 −2 src/cache/core/types/Cache.ts
  129. +3 −2 src/cache/core/types/DataProxy.ts
  130. +24 −4 src/cache/core/types/common.ts
  131. +9 −0 src/cache/index.ts
  132. +284 −0 src/cache/inmemory/__tests__/fragmentRegistry.ts
  133. +74 −0 src/cache/inmemory/__tests__/policies.ts
  134. +184 −10 src/cache/inmemory/__tests__/writeToStore.ts
  135. +165 −0 src/cache/inmemory/fragmentRegistry.ts
  136. +42 −6 src/cache/inmemory/helpers.ts
  137. +19 −8 src/cache/inmemory/inMemoryCache.ts
  138. +1 −1 src/cache/inmemory/policies.ts
  139. +25 −25 src/cache/inmemory/readFromStore.ts
  140. +3 −0 src/cache/inmemory/types.ts
  141. +17 −8 src/cache/inmemory/writeToStore.ts
  142. +46 −46 src/core/ApolloClient.ts
  143. +83 −7 src/core/LocalState.ts
  144. +256 −129 src/core/ObservableQuery.ts
  145. +41 −11 src/core/QueryInfo.ts
  146. +281 −144 src/core/QueryManager.ts
  147. +1,276 −1,046 src/core/__tests__/ObservableQuery.ts
  148. +142 −76 src/core/__tests__/QueryManager/index.ts
  149. +449 −0 src/core/__tests__/fetchPolicies.ts
  150. +0 −1 src/core/index.ts
  151. +10 −1 src/core/types.ts
  152. +24 −4 src/core/watchQueryOptions.ts
  153. +34 −0 src/errors/__tests__/ApolloError.ts
  154. +57 −29 src/errors/index.ts
  155. +72 −5 src/link/batch-http/__tests__/batchHttpLink.ts
  156. +3 −2 src/link/batch-http/batchHttpLink.ts
  157. +285 −39 src/link/batch/__tests__/batchLink.ts
  158. +88 −71 src/link/batch/batching.ts
  159. +3 −2 src/link/context/index.ts
  160. +79 −13 src/link/core/types.ts
  161. +576 −2 src/link/http/__tests__/HttpLink.ts
  162. +149 −0 src/link/http/__tests__/headerNormalization.ts
  163. +17 −1 src/link/http/__tests__/parseAndCheckHttpResponse.ts
  164. +510 −0 src/link/http/__tests__/responseIterator.ts
  165. +356 −0 src/link/http/__tests__/responseIteratorNoAsyncIterator.ts
  166. +0 −25 src/link/http/__tests__/selectHttpOptionsAndBody.ts
  167. +41 −52 src/link/http/createHttpLink.ts
  168. +21 −0 src/link/http/iterators/LICENSE
  169. +18 −0 src/link/http/iterators/async.ts
  170. +94 −0 src/link/http/iterators/nodeStream.ts
  171. +43 −0 src/link/http/iterators/promise.ts
  172. +29 −0 src/link/http/iterators/reader.ts
  173. +227 −41 src/link/http/parseAndCheckHttpResponse.ts
  174. +47 −0 src/link/http/responseIterator.ts
  175. +56 −11 src/link/http/selectHttpOptionsAndBody.ts
  176. +115 −64 src/link/persisted-queries/__tests__/{index.ts → persisted-queries.test.ts}
  177. +30 −16 src/link/persisted-queries/__tests__/{react.tsx → react.test.tsx}
  178. +42 −17 src/link/persisted-queries/index.ts
  179. +72 −1 src/link/subscriptions/__tests__/graphqlWsLink.ts
  180. +13 −13 src/link/subscriptions/index.ts
  181. +2 −2 src/react/components/Query.tsx
  182. +4 −2 src/react/components/Subscription.tsx
  183. +101 −45 src/react/components/__tests__/client/Mutation.test.tsx
  184. +56 −51 src/react/components/__tests__/client/Query.test.tsx
  185. +80 −5 src/react/components/__tests__/client/Subscription.test.tsx
  186. +5 −2 src/react/components/__tests__/ssr/getDataFromTree.test.tsx
  187. +1 −0 src/react/components/__tests__/ssr/server.test.tsx
  188. +2 −2 src/react/components/types.ts
  189. +3 −5 src/react/context/__tests__/ApolloConsumer.test.tsx
  190. +7 −9 src/react/context/__tests__/ApolloProvider.test.tsx
  191. +3 −3 src/react/hoc/__tests__/mutations/index.test.tsx
  192. +2 −1 src/react/hoc/__tests__/mutations/queries.test.tsx
  193. +9 −14 src/react/hoc/__tests__/queries/api.test.tsx
  194. +31 −35 src/react/hoc/__tests__/queries/errors.test.tsx
  195. +24 −17 src/react/hoc/__tests__/queries/index.test.tsx
  196. +50 −72 src/react/hoc/__tests__/queries/lifecycle.test.tsx
  197. +63 −56 src/react/hoc/__tests__/queries/loading.test.tsx
  198. +12 −15 src/react/hoc/__tests__/queries/observableQuery.test.tsx
  199. +54 −3 src/react/hoc/__tests__/queries/polling.test.tsx
  200. +0 −76 src/react/hoc/__tests__/queries/recomposeWithState.js
  201. +81 −0 src/react/hoc/__tests__/queries/recomposeWithState.ts
  202. +17 −23 src/react/hoc/__tests__/queries/skip.test.tsx
  203. +13 −12 src/react/hoc/__tests__/ssr/getDataFromTree.test.tsx
  204. +1 −0 src/react/hoc/__tests__/ssr/server.test.tsx
  205. +24 −12 src/react/hoc/__tests__/subscriptions/subscriptions.test.tsx
  206. +4 −3 src/react/hoc/graphql.tsx
  207. +3 −3 src/react/hoc/mutation-hoc.tsx
  208. +4 −4 src/react/hoc/query-hoc.tsx
  209. +3 −3 src/react/hoc/subscription-hoc.tsx
  210. +1 −1 src/react/hoc/types.ts
  211. +1 −2 src/react/hooks/__tests__/useApolloClient.test.tsx
  212. +914 −0 src/react/hooks/__tests__/useFragment.test.tsx
  213. +979 −181 src/react/hooks/__tests__/useLazyQuery.test.tsx
  214. +729 −83 src/react/hooks/__tests__/useMutation.test.tsx
  215. +5,403 −2,344 src/react/hooks/__tests__/useQuery.test.tsx
  216. +44 −24 src/react/hooks/__tests__/useReactiveVar.test.tsx
  217. +549 −57 src/react/hooks/__tests__/useSubscription.test.tsx
  218. +2 −1 src/react/hooks/index.ts
  219. +120 −0 src/react/hooks/useFragment.ts
  220. +59 −47 src/react/hooks/useLazyQuery.ts
  221. +22 −11 src/react/hooks/useMutation.ts
  222. +532 −302 src/react/hooks/useQuery.ts
  223. +58 −15 src/react/hooks/useSubscription.ts
  224. +128 −0 src/react/hooks/useSyncExternalStore.ts
  225. +25 −18 src/react/parser/index.ts
  226. +34 −8 src/react/ssr/RenderPromises.ts
  227. +81 −4 src/react/ssr/__tests__/useQuery.test.tsx
  228. +3 −2 src/react/ssr/getDataFromTree.ts
  229. +2 −1 src/react/ssr/renderToStringWithData.ts
  230. +60 −37 src/react/types/types.ts
  231. +2 −0 src/testing/core/index.ts
  232. +1 −1 src/testing/core/itAsync.ts
  233. +23 −4 src/testing/core/mocking/mockLink.ts
  234. +1 −4 src/testing/core/mocking/mockQueryManager.ts
  235. +2 −5 src/testing/core/mocking/mockWatchQuery.ts
  236. +11 −18 src/testing/core/subscribeAndCount.ts
  237. +7 −0 src/testing/core/wait.ts
  238. +4 −1 src/testing/react/MockedProvider.tsx
  239. +156 −18 src/testing/react/__tests__/MockedProvider.test.tsx
  240. +8 −8 src/testing/react/__tests__/__snapshots__/MockedProvider.test.tsx.snap
  241. +9 −4 src/testing/react/__tests__/mockSubscriptionLink.test.tsx
  242. +11 −0 src/utilities/common/__tests__/canUse.ts
  243. +3 −0 src/utilities/common/arrays.ts
  244. +29 −4 src/utilities/common/canUse.ts
  245. +1 −1 src/utilities/common/cloneDeep.ts
  246. +24 −3 src/utilities/common/errorHandling.ts
  247. +64 −0 src/utilities/common/incrementalResult.ts
  248. +10 −14 src/utilities/common/mergeDeep.ts
  249. +27 −0 src/utilities/common/mergeOptions.ts
  250. +32 −0 src/utilities/common/responseIterator.ts
  251. +192 −2 src/utilities/graphql/__tests__/directives.ts
  252. +476 −1 src/utilities/graphql/__tests__/transform.ts
  253. +34 −9 src/utilities/graphql/directives.ts
  254. +11 −4 src/utilities/graphql/fragments.ts
  255. +14 −8 src/utilities/graphql/getFromAST.ts
  256. +330 −167 src/utilities/graphql/transform.ts
  257. +4 −0 src/utilities/index.ts
  258. +60 −40 src/utilities/observables/Concast.ts
  259. +175 −0 src/utilities/observables/__tests__/Concast.ts
  260. +16 −12 src/utilities/policies/pagination.ts
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
14 changes: 14 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
"changelog": [
"@changesets/changelog-github",
{ "repo": "apollographql/apollo-client" }
],
"commit": false,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
45 changes: 13 additions & 32 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -3,55 +3,35 @@ version: 2
jobs:
Filesize:
docker:
- image: circleci/node:16.13.1
- image: cimg/node:19.8.1
steps:
- checkout
- run: npm run ci:precheck
- restore_cache:
keys:
# When lock file changes, use increasingly general patterns to
# restore cache
- npm-v3-{{ .Branch }}-{{ checksum "package-lock.json" }}
- npm-v3-{{ .Branch }}-
- npm-v3-
- run: npm version
- run: npm ci
- save_cache:
key: npm-v3-{{ .Branch }}-{{ checksum "package-lock.json" }}
paths:
# This should cache the npm cache instead of node_modules, which is
# needed because npm ci actually removes node_modules before
# installing to guarantee a clean slate.
- ~/.npm
- run: npm run bundlesize

Lint:
docker:
- image: cimg/node:19.8.1
steps:
- checkout
- run: npm version
- run: npm ci
- run: npm run lint

Tests:
docker:
- image: circleci/node:16.13.1
- image: cimg/node:19.8.1
steps:
- checkout
- run: npm run ci:precheck
- restore_cache:
keys:
# When lock file changes, use increasingly general patterns to
# restore cache
- npm-v3-{{ .Branch }}-{{ checksum "package-lock.json" }}
- npm-v3-{{ .Branch }}-
- npm-v3-
- run: npm version
- run: npm ci
- save_cache:
key: npm-v3-{{ .Branch }}-{{ checksum "package-lock.json" }}
paths:
# This should cache the npm cache instead of node_modules, which is
# needed because npm ci actually removes node_modules before
# installing to guarantee a clean slate.
- ~/.npm
- run:
name: Jest suite with coverage
command: npm run test:ci
environment:
JEST_JUNIT_OUTPUT: "reports/junit/js-test-results.xml"
JEST_JUNIT_OUTPUT_FILE: "reports/junit/js-test-results.xml"
- store_test_results:
path: reports/junit
- store_artifacts:
@@ -63,3 +43,4 @@ workflows:
jobs:
- Filesize
- Tests
- Lint
21 changes: 21 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"env": {
"browser": true,
"node": true,
"es2021": true
},
"parserOptions": {
"ecmaVersion": "latest"
},
"overrides": [
{
"files": ["**/__tests__/**/*.[jt]sx", "**/?(*.)+(test).[jt]sx"],
"extends": ["plugin:testing-library/react"],
"rules": {
"testing-library/prefer-user-event": "error"
}
}
]
}
2 changes: 2 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# format "ObservableQuery" test (in #10597)
104bf11765b1db50292f9656aa8fe48e2d749a83
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Bug
description: File a bug report
body:
- type: markdown
attributes:
value: "Hello from the Apollo Client team! Hopefully we can help resolve your issue. To increase the chances of us being able to help, please take the time to fill out the form as completely as possible. A minimal, runnable reproduction is the best way to get us to help you quickly and in many cases we simply cannot help without one."
- type: textarea
attributes:
label: Issue Description
description: Describe the issue you are experiencing.
validations:
required: false
- type: input
attributes:
label: Link to Reproduction
description: A link with runnable reproduction. You can fork our `react-apollo-error-template` to create one via [GitHub repository](https://github.com/apollographql/react-apollo-error-template) or [CodeSandbox](https://codesandbox.io/s/github/apollographql/react-apollo-error-template). Make sure this includes everything necessary (`package.json`, `tsconfig.json`, etc.) so we don't have to guess anything!
validations:
required: true
- type: textarea
attributes:
label: Reproduction Steps
description: Please provide any additional non-trivial steps required to reproduce the issue.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/question-discussion.md
Original file line number Diff line number Diff line change
@@ -5,6 +5,7 @@ about: Questions / discussions are best posted in our community forums or StackO

Need help or want to talk all things Apollo Client? Issues here are reserved for bugs, but one of the following resources should help:

* Apollo Discord server: https://discord.gg/graphos
* Apollo GraphQL community forums: https://community.apollographql.com
* StackOverflow (`apollo-client` tag): https://stackoverflow.com/questions/tagged/apollo-client
* Apollo Feature Request repo: https://github.com/apollographql/apollo-feature-requests
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -20,5 +20,6 @@

### Checklist:

- [ ] If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see [CONTRIBUTING.md](https://github.com/apollographql/apollo-client/blob/main/CONTRIBUTING.md#changesets))
- [ ] If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
- [ ] Make sure all of the significant new logic is covered by tests
179 changes: 179 additions & 0 deletions .github/workflows/close-stale-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
#
# You can adjust the behavior by modifying this file.
# For more information, see:
# https://github.com/actions/stale
name: Mark stale issues and pull requests

on:
schedule:
- cron: '15 5 * * *'

jobs:
stale:
# Prevents action from running on forks
if: github.repository == 'apollographql/apollo-client'
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write

steps:
- name: Close Stale Issues
uses: actions/stale@v8.0.0
with:
# # Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.
# repo-token: # optional, default is ${{ github.token }}

# # The message to post on the issue when tagging it. If none provided, will not mark issues stale.
#. stale-issue-message: # optional

# # The message to post on the pull request when tagging it. If none provided, will not mark pull requests stale.
# stale-pr-message: # optional

# The message to post on the issue when closing it. If none provided, will not comment when closing an issue.
close-issue-message: "We're closing this issue now but feel free to ping the maintainers or open a new issue if you still need support. Thank you!"

# # The message to post on the pull request when closing it. If none provided, will not comment when closing a pull requests.
# close-pr-message: # optional

# The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.
days-before-stale: -1

# The number of days old an issue can be before marking it stale. Set to -1 to never mark issues as stale automatically. Override "days-before-stale" option regarding only the issues.
days-before-issue-stale: -1

# The number of days old a pull request can be before marking it stale. Set to -1 to never mark pull requests as stale automatically. Override "days-before-stale" option regarding only the pull requests.
days-before-pr-stale: -1

# The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.
days-before-close: -1

# The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.
days-before-issue-close: 30

# The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.
days-before-pr-close: -1

# The label to apply when an issue is stale.
stale-issue-label: "🏓 awaiting-contributor-response"

# # The label to apply when an issue is closed.
# close-issue-label: # optional

# # The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2").
# exempt-issue-labels: # optional, default is

# The reason to use when closing an issue.
close-issue-reason: not_planned

# # The label to apply when a pull request is stale.
# stale-pr-label: # optional, default is Stale

# # The label to apply when a pull request is closed.
# close-pr-label: # optional

# # The labels that mean a pull request is exempt from being marked as stale. Separate multiple labels with commas (eg. "label1,label2").
# exempt-pr-labels: # optional, default is

# # The milestones that mean an issue or a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2").
# exempt-milestones: # optional, default is

# # The milestones that mean an issue is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the issues.
# exempt-issue-milestones: # optional, default is

# # The milestones that mean a pull request is exempt from being marked as stale. Separate multiple milestones with commas (eg. "milestone1,milestone2"). Override "exempt-milestones" option regarding only the pull requests.
# exempt-pr-milestones: # optional, default is

# # Exempt all issues and pull requests with milestones from being marked as stale. Default to false.
# exempt-all-milestones: # optional, default is false

# # Exempt all issues with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the issues.
# exempt-all-issue-milestones: # optional, default is

# # Exempt all pull requests with milestones from being marked as stale. Override "exempt-all-milestones" option regarding only the pull requests.
# exempt-all-pr-milestones: # optional, default is

# # Only issues or pull requests with all of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.
# only-labels: # optional, default is

# # Only issues or pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels.
# any-of-labels: # optional, default is

# Only issues with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the issues.
any-of-issue-labels: "🏓 awaiting-contributor-response"

# # Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests.
# any-of-pr-labels: # optional, default is

# # Only issues with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the issues.
# only-issue-labels: # optional, default is

# # Only pull requests with all of these labels are checked if stale. Defaults to `[]` (disabled) and can be a comma-separated list of labels. Override "only-labels" option regarding only the pull requests.
# only-pr-labels: # optional, default is

# The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).
operations-per-run: 500 # optional, default is 30

# Remove stale labels from issues and pull requests when they are updated or commented on.
remove-stale-when-updated: false

# Remove stale labels from issues when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the issues.
remove-issue-stale-when-updated: true

# Remove stale labels from pull requests when they are updated or commented on. Override "remove-stale-when-updated" option regarding only the pull requests.
remove-pr-stale-when-updated: false

# Run the processor in debug mode without actually performing any operations on live issues.
debug-only: false

# # The order to get issues or pull requests. Defaults to false, which is descending.
# ascending: # optional, default is false

# Delete the git branch after closing a stale pull request.
delete-branch: false

# # The date used to skip the stale action on issue/pull request created before it (ISO 8601 or RFC 2822).
# start-date: # optional, default is

# # The assignees which exempt an issue or a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2").
# exempt-assignees: # optional, default is

# # The assignees which exempt an issue from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the issues.
# exempt-issue-assignees: # optional, default is

# # The assignees which exempt a pull request from being marked as stale. Separate multiple assignees with commas (eg. "user1,user2"). Override "exempt-assignees" option regarding only the pull requests.
# exempt-pr-assignees: # optional, default is

# # Exempt all issues and pull requests with assignees from being marked as stale. Default to false.
# exempt-all-assignees: # optional, default is false

# Exempt all issues with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the issues.
exempt-all-issue-assignees: true

# # Exempt all pull requests with assignees from being marked as stale. Override "exempt-all-assignees" option regarding only the pull requests.
# exempt-all-pr-assignees: # optional, default is

# # Exempt draft pull requests from being marked as stale. Default to false.
# exempt-draft-pr: # optional, default is false

# # Display some statistics at the end regarding the stale workflow (only when the logs are enabled).
enable-statistics: true

# # A comma delimited list of labels to add when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.
# labels-to-add-when-unstale: # optional, default is

# A comma delimited list of labels to remove when a stale issue or pull request receives activity and has the stale-issue-label or stale-pr-label removed from it.
labels-to-remove-when-unstale: "🏓 awaiting-contributor-response"

# Any update (update/comment) can reset the stale idle time on the issues and pull requests.
ignore-updates: false

# Any update (update/comment) can reset the stale idle time on the issues. Override "ignore-updates" option regarding only the issues.
ignore-issue-updates: false

# Any update (update/comment) can reset the stale idle time on the pull requests. Override "ignore-updates" option regarding only the pull requests.
ignore-pr-updates: false

# # Only the issues or the pull requests with an assignee will be marked as stale automatically.
# include-only-assigned: # optional, default is false
Loading