Unsupported --include-verbatim argument
#116
Comments
StevenMaude
added a commit
to opensafely/documentation
that referenced
this issue
May 11, 2022
Based on the default configuration: https://github.com/lycheeverse/lychee-action/blob/c0d1093b783f7ad0c445884b01da0215b2da29ee/action.yml#L6 but add: * `--exclude-mail` to ignore email addresses (as this check seems to fail with a GitHub Actions runner) * `--require-https` to flag `http` links that could be `https` There is also an upcoming change of behaviour which will mean needing to add `--include-verbatim` to continuing checking links within `pre` and `code` blocks. This is in the `main` branch of lychee, but not available in the action yet. See lycheeverse/lychee-action#116.
StevenMaude
added a commit
to opensafely/documentation
that referenced
this issue
May 11, 2022
Based on the default configuration: https://github.com/lycheeverse/lychee-action/blob/c0d1093b783f7ad0c445884b01da0215b2da29ee/action.yml#L6 but add: * `--exclude-mail` to ignore email addresses (as this check seems to fail with a GitHub Actions runner) * `--require-https` to flag `http` links that could be `https` There is also an upcoming change of behaviour which will mean needing to add `--include-verbatim` to continuing checking links within `pre` and `code` blocks. This is in the `main` branch of lychee, but not available in the action yet. See lycheeverse/lychee-action#116.
|
You're right. I was waiting for #115, but I guess it's fine if we just create a new release right away. |
|
Version 1.5.0 with lychee v0.10.0 was just released. |
StevenMaude
added a commit
to opensafely/documentation
that referenced
this issue
May 31, 2022
This continues to check code blocks. It was the previous behaviour, but changed in lychee. The v1.5.0 lychee action has an updated lychee, which now supports and enforces this flag now. See lycheeverse/lychee-action#116 and lycheeverse/lychee-action#117.
StevenMaude
added a commit
to opensafely/documentation
that referenced
this issue
May 31, 2022
This checks links in code blocks. It was the previous default lychee behaviour by default, but recently changed. So we need to enable this to continue these checks, as we've now updated the lychee action (#758). See lycheeverse/lychee-action#116 and lycheeverse/lychee-action#117.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I'm not entirely sure whether it's better to open the issue here or with lychee itself: it relates a little to the release process for both. But I encountered it here, so opening here.
From this repository's README:
As a user, I diligently read the docs and see
--include-verbatimlisted. On trying that flag:and then get puzzled 🤔
Then I realise it's because
--include-verbatimwas added after the current latest versioned release of lychee (0.9.0). And this action uses the 0.9.0 release.This inconsistency would be fixed by a new release of lychee and then updating the image here.
(I'm trying lychee out for one or two projects and it looks really good, by the way; thanks! ❤️)
The text was updated successfully, but these errors were encountered: