Skip to content
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

Broken Link Checker #338

Merged
merged 9 commits into from
May 14, 2024
Merged

Broken Link Checker #338

merged 9 commits into from
May 14, 2024

Conversation

kshitjee
Copy link
Contributor

Description

Add github workflow to fail in CI if broken links are detected in any HTML or Markdown files under apps/nextra.

Checklist

  • Do all Lints pass?
    • [] Have you ran pnpm spellcheck?
    • [] Have you ran pnpm fmt?
    • [] Have you ran pnpm lint?

Copy link

vercel bot commented May 14, 2024

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

Name Status Preview Comments Updated (UTC)
developer-docs-nextra ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 14, 2024 9:39pm

@kshitjee kshitjee requested a review from hariria May 14, 2024 20:28
Copy link

netlify bot commented May 14, 2024

Deploy Preview for aptos-developer-docs ready!

Name Link
🔨 Latest commit ef6ada7
🔍 Latest deploy log https://app.netlify.com/sites/aptos-developer-docs/deploys/6643d9ad416c7a0008f8078c
😎 Deploy Preview https://deploy-preview-338--aptos-developer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

- name: Run Lychee Link Checker
uses: lycheeverse/lychee-action@v1
with:
args: --base . --verbose --no-progress './apps/nextra/**/*.mdx' './apps/nextra/**/*.html'
Copy link
Collaborator

Choose a reason for hiding this comment

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

We probably need to figure out how to ignore localhost links.

This is why the broken link checker wasn't blocking before

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you give an example of what you mean by a local host link (I know what it is but when would it arise in the docs?)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Just take a look at the output from the PR run

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh lmfao i see thanks. @kshitjee maybe something like this lycheeverse/lychee#1384 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it ignores localhost links now, check latest workflow run

@kshitjee kshitjee merged commit d45ef3d into main May 14, 2024
8 checks passed
@kshitjee kshitjee deleted the kc/link-checker branch May 14, 2024 21:52
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.

3 participants