Skip to content

Commit cdab6e2

Browse files
authored
ci: add link verification step to PR workflow (#9267)
1 parent 5b017d1 commit cdab6e2

File tree

6 files changed

+366
-264
lines changed

6 files changed

+366
-264
lines changed

.github/workflows/pr.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ jobs:
3535
main-branch-name: main
3636
- name: Run Checks
3737
run: pnpm run test:pr --parallel=3
38+
- name: Verify Links
39+
run: pnpm run verify-links
3840
- name: Stop Nx Agents
3941
if: ${{ always() }}
4042
run: npx nx-cloud stop-all-agents

docs/framework/react/guides/important-defaults.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Out of the box, TanStack Query is configured with **aggressive but sane** defaul
1111
1212
- A Query that has a `staleTime` set is considered **fresh** until that `staleTime` has elapsed.
1313

14-
- set `staleTime` to e.g. `2 * 60 * 1000` to make sure data is read from the cache, without triggering any kinds of refetches, for 2 minutes, or until the Query is [invalidated manually](./query-invalidation.md).
15-
- set `staleTime` to `Infinity` to never trigger a refetch until the Query is [invalidated manually](./query-invalidation.md).
16-
- set `staleTime` to `'static'` to **never** trigger a refetch, even if the Query is [invalidated manually](./query-invalidation.md).
14+
- set `staleTime` to e.g. `2 * 60 * 1000` to make sure data is read from the cache, without triggering any kinds of refetches, for 2 minutes, or until the Query is [invalidated manually](../query-invalidation.md).
15+
- set `staleTime` to `Infinity` to never trigger a refetch until the Query is [invalidated manually](../query-invalidation.md).
16+
- set `staleTime` to `'static'` to **never** trigger a refetch, even if the Query is [invalidated manually](../query-invalidation.md).
1717

1818
- Stale queries are refetched automatically in the background when:
1919
- New instances of the query mount

knip.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
"$schema": "https://unpkg.com/knip@5/schema.json",
33
"ignore": [
44
".pnpmfile.cjs",
5-
"scripts/*.js",
5+
"scripts/*.{j,t}s",
66
"**/root.*.config.*",
77
"**/ts-fixture/file.ts"
88
],
99
"ignoreDependencies": [
1010
"@types/react",
1111
"@types/react-dom",
1212
"react",
13-
"react-dom"
13+
"react-dom",
14+
"markdown-link-extractor"
1415
],
1516
"ignoreWorkspaces": ["examples/**", "integrations/**"],
1617
"workspaces": {

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"prettier:write": "pnpm run prettier --write",
3030
"docs:generate": "node scripts/generateDocs.js",
3131
"cipublish": "node scripts/publish.js",
32-
"verify-links": "node scripts/verify-links.ts"
32+
"verify-links": "pnpm tsx scripts/verify-links.ts"
3333
},
3434
"nx": {
3535
"includedScripts": [
@@ -65,6 +65,7 @@
6565
"react-dom": "^19.0.0",
6666
"sherif": "^1.0.0",
6767
"tsup": "^8.4.0",
68+
"tsx": "^4.20.1",
6869
"typescript": "5.8.3",
6970
"typescript50": "npm:[email protected]",
7071
"typescript51": "npm:[email protected]",

0 commit comments

Comments
 (0)