-
Notifications
You must be signed in to change notification settings - Fork 332
ci(developer-hub): add lychee link checker for docs #3552
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
aditya520
wants to merge
1
commit into
main
Choose a base branch
from
claude/nifty-chatelet
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: Check developer-hub links | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - "apps/developer-hub/content/**" | ||
| - "apps/developer-hub/src/**" | ||
| - .github/workflows/ci-developer-hub-links.yml | ||
| - .lycheeignore | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - "apps/developer-hub/content/**" | ||
| - "apps/developer-hub/src/**" | ||
|
|
||
| concurrency: | ||
| group: links-${{ github.head_ref || github.run_id }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| check-links: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Check links | ||
| uses: lycheeverse/lychee-action@v2 | ||
| with: | ||
| args: >- | ||
| --base https://docs.pyth.network | ||
| --no-progress | ||
| --exclude-path apps/developer-hub/node_modules | ||
| 'apps/developer-hub/content/**/*.mdx' | ||
| 'apps/developer-hub/content/**/*.md' | ||
| fail: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Placeholder / example URLs in code snippets | ||
| YOUR_ | ||
| REPLACE_ | ||
| example\.com | ||
|
|
||
| # Blockchain explorer links with placeholder addresses | ||
| 0xYOUR | ||
|
|
||
| # RPC / API endpoints that require auth or may rate-limit | ||
| https://hermes\.pyth\.network/docs/openapi\.json |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The concurrency key uses
github.head_ref, which is only the source branch name, so different pull requests that happen to use the same branch name (for examplepatch-1from different forks) will share one group and cancel each other’s runs. This means link checks can be terminated for unrelated PRs, leaving missing or flaky status checks; use a PR-unique value likegithub.event.pull_request.number(with a push fallback) to ensure cancellation only affects stale runs of the same PR.Useful? React with 👍 / 👎.