Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions .github/workflows/link_check.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# This action checks for broken links
name: Check Links
name: Check for broken links

on:
push:
pull_request:
schedule:
- cron: "00 00 * * *"
# Runs weekly on Monday at 00:00
- cron: "0 0 * * 1"

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- name: Restore lychee cache
uses: actions/cache@v5
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

- name: 🔗 Check Links
uses: lycheeverse/lychee-action@v2
with:
jobSummary: true
args: --base-url "$(pwd)" --cache --max-cache-age 1d --config .github/workflows/lychee.toml './**/*.md'
lycheeVersion: latest
format: markdown
args: >
--base https://pestphp.com
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to check, this doesn't actually scan broken links on the live site, it checks the local docs?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@owenvoke owenvoke Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

--user-agent "Mozilla 5.0"
--exclude "https?://(www\.)?(twitter\.com|instagram\.com|linkedin\.com|gnu\.org)"
--max-retries 5
--verbose
--no-progress
"**/*.md"
121 changes: 0 additions & 121 deletions .github/workflows/lychee.toml

This file was deleted.

2 changes: 1 addition & 1 deletion browser-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ Sometimes you may want to debug your browser tests. Pest provides a convenient w
./vendor/bin/pest --debug
```

Optionally, you can also use the `debug()` method in your test. It will limit execution to this test (like using [`only()`](filtering-tests.md#only)), pause the execution and open the browser window:
Optionally, you can also use the `debug()` method in your test. It will limit execution to this test (like using [`only()`](/docs/filtering-tests#only)), pause the execution and open the browser window:

```php
$page->debug();
Expand Down
Loading