search

urfave / cli

A simple, fast, and fun package for building command line apps in Go
https://cli.urfave.org
MIT License
21.91k stars 1.69k forks source link

The document includes broken links #1939

Open suzuki-shunsuke opened 3 days ago

suzuki-shunsuke commented 3 days ago

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 commented 3 days ago

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

suzuki-shunsuke commented 2 days ago

https://github.com/urfave/cli/pull/1940#issuecomment-2198357217

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.%