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

The document includes broken links #1939

Open
suzuki-shunsuke opened this issue Jun 29, 2024 · 4 comments
Open

The document includes broken links #1939

suzuki-shunsuke opened this issue Jun 29, 2024 · 4 comments

Comments

@suzuki-shunsuke
Copy link
Contributor

I checked links in the document using https://github.com/lycheeverse/lychee .

$ git ls-files | grep -E "\.md$" | xargs lychee --max-concurrency 10 -a 429
  247/247 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                                       Issues found in 6 inputs. Find details below.

[.github/ISSUE_TEMPLATE/v1-bug-report.md]:
✗ [404] https://github.com/urfave/cli/blob/main/docs/v1/manual.md | Failed: Network error: Not Found

[.github/ISSUE_TEMPLATE/v2-bug-report.md]:
✗ [404] https://github.com/urfave/cli/blob/main/docs/v2/manual.md | Failed: Network error: Not Found

[docs/index.md]:
↻ [404] https://github.com/urfave/cli/blob/main/.github/workflows/cli.yml | Cached: Error (cached)

[.github/ISSUE_TEMPLATE/v3-feature-request.md]:
✗ [404] https://github.com/urfave/cli/blob/main/docs/v3/manual.md | Failed: Network error: Not Found

[docs/CHANGELOG.md]:
✗ [404] https://github.com/lynncyrin | Failed: Network error: Not Found
✗ [404] https://github.com/urfave/cli/compare/v1.22.4...v1 | Failed: Network error: Not Found
✗ [404] https://github.com/urfave/891 | Failed: Network error: Not Found
✗ [404] https://github.com/masonj188 | Failed: Network error: Not Found
✗ [404] https://github.com/lynncyrin/ | Failed: Network error: Not Found

[docs/CONTRIBUTING.md]:
✗ [ERR] file:///Users/shunsukesuzuki/repos/src/github.com/urfave/cli/docs/RELEASING | Failed: Cannot find file
✗ [404] https://github.com/urfave/cli/tree/v1 | Failed: Network error: Not Found
✗ [404] https://github.com/urfave/cli/blob/main/.github/workflows/cli.yml | Failed: Network error: Not Found

🔍 247 Total (in 11s) ✅ 230 OK 🚫 13 Errors 💤 4 Excluded
💡 There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.%
@suzuki-shunsuke
Copy link
Contributor Author

suzuki-shunsuke commented Jun 29, 2024

✅ I'll send a pull request to fix some broken links.

@suzuki-shunsuke
Copy link
Contributor Author

#1940 (comment)

#1940 fixed some broken links, but some links are still broken.

$ git ls-files | grep -E "\.md$" | xargs lychee --max-concurrency 10 -a 429
  247/247 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                                       Issues found in 2 inputs. Find details below.

[docs/CHANGELOG.md]:
✗ [404] https://github.com/lynncyrin/ | Failed: Network error: Not Found
✗ [404] https://github.com/urfave/cli/compare/v1.22.4...v1 | Failed: Network error: Not Found
✗ [404] https://github.com/masonj188 | Failed: Network error: Not Found
✗ [404] https://github.com/urfave/891 | Failed: Network error: Not Found

[docs/CONTRIBUTING.md]:
✗ [404] https://github.com/urfave/cli/tree/v1 | Failed: Network error: Not Found

🔍 247 Total (in 12s) ✅ 237 OK 🚫 6 Errors 💤 4 Excluded
💡 There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.%

@dearchap
Copy link
Contributor

@suzuki-shunsuke Do you think adding the lychee github action https://github.com/lycheeverse/lychee-action to our workflow would help detect this. ?

@suzuki-shunsuke
Copy link
Contributor Author

That's a nice idea.

$ git ls-files | grep -E "\.md$" | xargs lychee --max-concurrency 10 -a 429
  252/252 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                          Issues found in 2 inputs. Find details below.

[docs/CHANGELOG.md]:
     [404] https://github.com/lynncyrin
     [404] https://github.com/masonj188
     [404] https://github.com/urfave/cli/compare/v1.22.4...v1
     [404] https://github.com/urfave/891
     [404] https://github.com/lynncyrin/

[docs/CONTRIBUTING.md]:
     [404] https://github.com/urfave/cli/tree/v1

🔍 252 Total (in 16s) ✅ 242 OK 🚫 6 Errors 👻 4 Excluded
   [WARN ] There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.

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

No branches or pull requests

2 participants