Skip to content

GitHub Actions: Check URLs using lychee#10680

Merged
mhilbrunner merged 1 commit into
godotengine:masterfrom
Calinou:ci-check-urls
Feb 19, 2025
Merged

GitHub Actions: Check URLs using lychee#10680
mhilbrunner merged 1 commit into
godotengine:masterfrom
Calinou:ci-check-urls

Conversation

@Calinou

@Calinou Calinou commented Feb 12, 2025

Copy link
Copy Markdown
Member

This makes it possible to be aware of dead links and replace them with other resources (such as archived versions) as soon as possible.

Note that class reference URLs not checked within this repository, as I plan to also integrate lychee into godotengine/godot's CI (which has the source of the class reference files).

Note

CI will fail until we resolve #10674, so that we remove the download.tuxfamily.org links from the docs.

@tetrapod00 tetrapod00 left a comment

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.

Approve the idea. Shader function replacement links are correct.

Can't review the lychee action implementation

Comment thread .lycheeignore Outdated
@skyace65

Copy link
Copy Markdown
Member

I rebased this PR since tetrapod's PR was merged and now the URL check is failing on a different link. I'm not sure why though because the link works for me.

This makes it possible to be aware of dead links and replace
them with other resources (such as archived versions) as
soon as possible.
@Calinou

Calinou commented Feb 17, 2025

Copy link
Copy Markdown
Member Author

I rebased this PR since tetrapod's PR was merged and now the URL check is failing on a different link. I'm not sure why though because the link works for me.

I've added gamedevartisan.com to exclusions. Some websites tend to block link checkers and will return various error codes (typically 429, but sometimes 403 or even 503 in this case).

@skyace65

Copy link
Copy Markdown
Member

@mhilbrunner I'd like your review before merging this since it's adding another check

@skyace65 skyace65 requested a review from mhilbrunner February 19, 2025 00:24

@mhilbrunner mhilbrunner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think something like this is a good idea, and I didn't spot anything in the workflow. Looks good to me!

Some things can be expanded, but I think we want to see this in action first & iterate. So, lets go ahead.

@mhilbrunner mhilbrunner added the github_actions Pull requests that update GitHub Actions code label Feb 19, 2025
@mhilbrunner mhilbrunner merged commit e2c795c into godotengine:master Feb 19, 2025
@mhilbrunner

Copy link
Copy Markdown
Member

Thank you!

@brotheramai

Copy link
Copy Markdown
Contributor

@Calinou
This action has been failing since 2025. Perhaps github updated in a way that broke compatibility? Here's a sample of the failure output:

Run lycheeverse/lychee-action@v2
Run echo "$HOME/.local/bin" >> "$GITHUB_PATH"
Run # Remove any existing lychee binary to prevent conflicts
Run # Create a temporary directory for downloads and extraction
Downloading from: https://github.com/lycheeverse/lychee/releases/download/lychee-v0.23.0/lychee-x86_64-unknown-linux-gnu.tar.gz
Extracting lychee-x86_64-unknown-linux-gnu.tar.gz
lychee
docs/
docs/README.md
docs/TROUBLESHOOTING.md
docs/lychee.1
docs/PRE_COMMIT.md
Run # Install lychee from the temporary directory
Run /home/runner/work/_actions/lycheeverse/lychee-action/v2/entrypoint.sh
error: invalid value '.' for '--base ': Error with base dir . : Base must either be a URL (with scheme) or an absolute local path. See --help for more information. If you want to resolve root-relative links in local files, also see --root-dir.

For more information, try '--help'.

@Calinou

Calinou commented May 16, 2026

Copy link
Copy Markdown
Member Author

@brotheramai Thanks for the reminder! I've opened a PR to fix this:

There is still one outstanding error I didn't manage to fix though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bisecting Regressions page out of date, including bad link

6 participants