ci: add lychee
#200
Draft
ci: add lychee
#200
Conversation
This file contains 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
github-actions
bot
added
A-workspace
hinto-janai
commented
Jun 28, 2024
Comment on lines
+141
to
+147
| # Run `lychee` at: | ||
| # 1. The repo root (excluding `target/`) | ||
| # 2. Cuprate's cargo documentation | ||
| - name: Lychee | ||
| run: | | ||
| lychee . --exclude target | ||
| lychee target/doc/cuprate_* |
There was a problem hiding this comment.
This is put inside ci.yml because we need access to target/doc.
This allows for scanning generated documentation, e.g. rpc/types have links that are generated with macros.
lychee.toml
Outdated
Comment on lines
12
to
13
| # Exclude URLs and mail addresses from checking (supports regex). | ||
| exclude = ["file://"] |
There was a problem hiding this comment.
Crate type links are excluded since our cargo doc CI catches it.
Comment on lines
+126
to
+127
| - name: Install dependencies (All) | ||
| run: cargo install lychee |
There was a problem hiding this comment.
I'm leaning towards not mentioning this in CONTRIBUTING.md since:
- Wrong links are infrequent
- This CI will show them anyway
| /// <https://cuprate.github.io/monero-book/consensus_rules/transactions/decoys.html> | ||
| /// <https://cuprate.github.io/monero-book/consensus_rules/transactions/inputs.html> |
There was a problem hiding this comment.
decoys.html doesn't exist anymore, is this a good replacement?
|
Going to fix CI first, sorry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
lycheeto CIlychee.tomlconfig fileThis checks if links are correct, this includes books, cargo docs, code, etc.