Conversation
.github/workflows/lychee.toml
Outdated
|
|
||
| # Custom request headers | ||
| headers = [] | ||
| header = { "accept" = "text/html", "x-custom-header" = "value" } |
There was a problem hiding this comment.
I don't think we need a custom header here. 👍🏻
| header = { "accept" = "text/html", "x-custom-header" = "value" } | |
| header = { "accept" = "text/html" } |
.github/workflows/lychee.toml
Outdated
| ############################# Runtime ############################# | ||
|
|
||
| # File to read and write cookies | ||
| cookie_jar = "cookie-jar" |
There was a problem hiding this comment.
Let's comment out bits that aren't relevant for us.
| cookie_jar = "cookie-jar" | |
| # cookie_jar = "cookie-jar" |
.github/workflows/lychee.toml
Outdated
| default_extension = "md" | ||
|
|
||
| # GitHub API token | ||
| github_token = "secret" |
There was a problem hiding this comment.
| github_token = "secret" | |
| # github_token = "secret" |
.github/workflows/lychee.toml
Outdated
| github_token = "secret" | ||
|
|
||
| # Resolve directories to index files | ||
| index_files = ["index.html"] |
There was a problem hiding this comment.
| index_files = ["index.html"] | |
| # index_files = ["index.html"] |
.github/workflows/lychee.toml
Outdated
| index_files = ["index.html"] | ||
|
|
||
| # Preprocess input files | ||
| preprocess = { command = "preprocess.sh" } |
There was a problem hiding this comment.
| preprocess = { command = "preprocess.sh" } | |
| # preprocess = { command = "preprocess.sh" } |
.github/workflows/lychee.toml
Outdated
|
|
||
| # Remap URI matching pattern to different URI. | ||
| remap = [ "https://example.com http://example.invalid" ] | ||
| remap = ["https://example.com http://example.invalid"] |
There was a problem hiding this comment.
| remap = ["https://example.com http://example.invalid"] | |
| # remap = ["https://example.com http://example.invalid"] |
|
Hi @owenvoke, Thanks for the feedback. I have simplified the GitHub action by using inline arguments and removing the config file. Greetings and thanks |
owenvoke
left a comment
owenvoke
left a comment
There was a problem hiding this comment.
LGTM. Just one more query.
| lycheeVersion: latest | ||
| format: markdown | ||
| args: > | ||
| --base https://pestphp.com |
There was a problem hiding this comment.
Just want to check, this doesn't actually scan broken links on the live site, it checks the local docs?
There was a problem hiding this comment.
I am not sure if I understood the question, but the base argument is used to resolve the local files as links.
[only()](/docs/filtering-tests#only) ➔ https://pestphp.com/docs/filtering-tests#only
If we have a broken link on the home page, it will not be detected, as this action only checks the .md doc files.
If you see fit, we could probably set up ScholliYT/Broken-Links-Crawler-Action scanning the live website (likely in the pestphp/pestphp.com repo). But it has always seemed to me that the website does not change so often that we risk having broken links outside the docs.
My original motivation with this action some years ago was to avoid broken links to external resources (e.g., Laravel and PHPUnit docs) when features are renamed/moved. If I remember well, there were a couple of cases in 2x doc revision.
There was a problem hiding this comment.
Cool, that's all good then! 👍🏻 I just wanted to make sure it was checking local files, and not the actual remote.
This LGTM. However, I'm no longer a Pest team member, so my approval won't lead to a merge.
2 participants
Hi @owenvoke,
This PR updates
lychee.tomlaccording to the example proposed in the actions feedback https://github.com/lycheeverse/lychee/blob/lychee-v0.23.0/lychee.example.tomlPS: Sorry for the goofy branch commit.