apache / apache/cloudstack

`lychee` pre-commit run: `Catch Broken Links in Seconds`

Open
#11,867 6 comments 0 reactions 1 assignee Claimed by @jbampton View on GitHub
type:enhancement
Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
6d 19h
Merged PRs (30d)
32

Description

refs https://github.com/apache/cloudstack/issues/11290

https://lychee.cli.rs/

So we have some broken links, others that should point to the direct links and some that need ignoring in the lychee config `lychee.toml`

My local config was:

```
- repo: https://github.com/lycheeverse/lychee.git
rev: lychee-v0.20.1
hooks:
- id: lychee
name: run lychee
description: run lychee a fast, async, stream-based link checker written in Rust
args: [--config=.github/linters/lychee.toml]
files: \.md$
```

pre-commit run output:

```
run lychee...............................................................Failed
- hook id: lychee
- exit code: 2

660/660 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links Issues found in 6 inputs. Find details below.

[CHANGES.md]:
[404] https://cloudstack.apache.org/docs/en-US/Apache_CloudStack/4.2.1/html/Release_Notes/version-4.2.html#issues-fixed-4.2.1 | Network error: Not Found
[404] https://cloudstack.apache.org/docs/en-US/Apache_CloudStack/4.2.0/html/Release_Notes/index.html | Network error: Not Found

[tools/devcloud4/README.md]:
[429] https://www.vagrantup.com/downloads.html | Network error: Too Many Requests
[404] https://downloads.chef.io/chef-dk/ | Network error: Not Found

[INSTALL.md]:
[ERROR] http://localhost:5050/ | Network error: error sending request for url (http://localhost:5050/) Maybe a certificate error?

[ui/README.md]:
[404] https://viserjs.github.io/docs.html#/viser/guide/installation | Network error: Not Found
[TIMEOUT] https://markmail.org/message/vxnskmwhfaagnm4r | Timeout
[404] https://iconka.com/en/downloads/cat-power/ | Network error: Not Found
[TIMEOUT] https://markmail.org/message/bgnn4xkjnlzseeuv | Timeout

[CONTRIBUTING.md]:
[404] https://github.com/YOUR_ACCOUNT/cloudstack | Network error: Not Found

[README.md]:
[404] https://cloudstack.apache.org/survey.html | Network error: Not Found

🔍 660 Total (in 47s) ✅ 641 OK 🚫 10 Errors 👻 6 Excluded ⏳ 2 Timeouts
[WARN ] There were issues with GitHub URLs. You could try setting a GitHub token and running lychee again.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.