Skip to content

ci: add link verification step to PR workflow #9267

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

ci: add link verification step to PR workflow #9267

wants to merge 3 commits into from

Conversation

manudeli
Copy link
Collaborator

@manudeli manudeli commented Jun 11, 2025 •
edited
Loading

image

@manudeli manudeli self-assigned this Jun 11, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 11, 2025
@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jun 11, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 2e14587.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 3m 14s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1m 53s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-11 16:20:33 UTC

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jun 11, 2025 •
edited
Loading

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@9267

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9267

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9267

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9267

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9267

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9267

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9267

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9267

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9267

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9267

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9267

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9267

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9267

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9267

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9267

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9267

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9267

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9267

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9267

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9267

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9267

commit: 2e14587

@codecov Codecov
Copy link

codecov bot commented Jun 11, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.37%. Comparing base (641ec86) to head (2e14587).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #9267   +/-   ##
=======================================
  Coverage   45.37%   45.37%           
=======================================
  Files         207      207           
  Lines        8276     8276           
  Branches     1871     1862    -9     
=======================================
  Hits         3755     3755           
  Misses       4080     4080           
  Partials      441      441
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental 85.00% <ø> (ø)
@tanstack/eslint-plugin-query 83.24% <ø> (ø)
@tanstack/query-async-storage-persister 43.85% <ø> (ø)
@tanstack/query-broadcast-client-experimental 24.39% <ø> (ø)
@tanstack/query-codemods 0.00% <ø> (ø)
@tanstack/query-core 98.15% <ø> (ø)
@tanstack/query-devtools 3.55% <ø> (ø)
@tanstack/query-persist-client-core 79.47% <ø> (ø)
@tanstack/query-sync-storage-persister 84.61% <ø> (ø)
@tanstack/query-test-utils 77.77% <ø> (ø)
@tanstack/react-query 95.93% <ø> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query 78.13% <ø> (ø)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client 100.00% <ø> (ø)
@tanstack/svelte-query 88.07% <ø> (ø)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client 100.00% <ø> (ø)
@tanstack/vue-query 71.10% <ø> (ø)
@tanstack/vue-query-devtools ∅ <ø> (∅)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

manudeli
manudeli commented Jun 11, 2025
View reviewed changes
package.json
@@ -29,7 +29,7 @@
"prettier:write": "pnpm run prettier --write",
"docs:generate": "node scripts/generateDocs.js",
"cipublish": "node scripts/publish.js",
"verify-links": "node scripts/verify-links.ts"
"verify-links": "pnpm tsx scripts/verify-links.ts"
Copy link
Collaborator Author

@manudeli manudeli Jun 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We should use tsx because the node version(22.12.0) defined in .nvmrc is lower than the one that supports TypeScript natively.

@manudeli manudeli marked this pull request as ready for review June 11, 2025 16:25
KevinVandy
KevinVandy reviewed Jun 11, 2025
View reviewed changes
.github/workflows/pr.yml
@@ -35,6 +35,8 @@ jobs:
main-branch-name: main
- name: Run Checks
run: pnpm run test:pr --parallel=3
- name: Verify Links
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if this should be added to autofix.yml either instead or in addition to here. Autofix will commit the fixes to the branch.

Copy link
Collaborator Author

@manudeli manudeli Jun 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Since this verify-links.ts only detects broken links but does not automatically fix them, I think it's more appropriate to keep it in ci.yml rather than autofix.yml. But please feel free to share if you had something else in mind

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KevinVandy KevinVandy KevinVandy left review comments

Assignees

@manudeli manudeli

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@manudeli @KevinVandy