*: remove marker in favor of Github action #3048
Conversation
openshift-ci-robot
added
the
do-not-merge/work-in-progress
estroz
force-pushed
the
chore/remove-marker
branch
2 times, most recently
from
57c5596 to
74797f4
Compare
estroz
force-pushed
the
chore/remove-marker
branch
2 times, most recently
from
060507f to
d69cab3
Compare
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
| excludes=$(grep -vxF -f .marker.tmp.changed .marker.tmp.all | sed -e 's/^/--exclude /') | ||
| rm .marker.tmp.* | ||
|
|
||
| ./hack/ci/marker --exclude website $excludes |
There was a problem hiding this comment.
With marker, we had to exclude files in the website directory (the links are built by hugo and I don't think they will work.)
IMO this should be blocked until gaurav-nelson/github-action-markdown-link-check#38 is implemented. (Or we could whitelist files to check)
There was a problem hiding this comment.
The config directs this checker to only check links in top-level files (max-depth: 1), so it ignores anything in website.
There was a problem hiding this comment.
If this will no longer check design, proposals, thats fine with me since those need to be moved anyway.
| @@ -0,0 +1,6 @@ | |||
| { | |||
There was a problem hiding this comment.
For this to be a drop in replacement, we need to only check changed files with check-modified-files-only option.
There was a problem hiding this comment.
We only wrote that functionality into the markdown checker because it was breaking on certain sites, and we knew the file it was breaking on wasn’t modified often. I think it’s safe to check all top-level files again.
There was a problem hiding this comment.
Also we need to check all links on each PR because a linked file could be moved, breaking links in unmodified docs.
There was a problem hiding this comment.
Cool, since we will be checking many fewer links, hopefully we won't get the 429s from github.
|
Lets keep a close eye on whether this can be a blocking check. For example, if we added a page to the website and a link to it in the README, the link target won't exist until after the PR merges. |
3 participants
Description of the change: use Github action link checker instead of
marker.Motivation for the change: use a more widely supported tool for markdown link checking, and use Github actions as to not block PR's if links break. We can make the link check required later.