BUG FIX #538 #760
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| file:///github/workspace/* | ||
| file:///home/runner/work/opensearch-py/opensearch-py/docs/source/README.md | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,16 @@ jobs: | |
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Remove symlink | ||
|
There was a problem hiding this comment. What's the purpose of removing the symlink if we're going to exclude it below? There was a problem hiding this comment. I tried excluding file(docs/source/readme.md) from link checking, but link checker excluding readme.md in both root and also in docs/source , so I tried removing symlink ,then link checker worked. The exclude below is not for excluding file, there may be a reference to this symlink file in other doc, so to ensure that link checker doesn't validate this reference as it is now-nonexistent soft link. Although it will still work without excluding this. There was a problem hiding this comment. Deleting the symlink is definitely a workaround, but not a pretty one. Let's figure out how to do without it, remove it. You also have |
||
| run: rm docs/source/README.md | ||
| - name: lychee Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/[email protected] | ||
| with: | ||
| args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt" "**/*.json" --exclude-file ".github/workflows/.lychee.excludes" --exclude-mail | ||
| fail: true | ||
| env: | ||
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | ||
| - name: Restore symlink | ||
| if: always() | ||
| run: ln -s ../../README.md docs/source/README.md | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are pattern matched/regexes, I think it should work without
file://, try*/github/workspace/**/docs/source/README.mdThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically removing sym link before link checker is my solution . Excluding (file:///home/runner/work/opensearch-py/opensearch-py/docs/source/README.md ) is needed . Let me give u a example, if u have readme as a relative link in some other doc, link checker will fail, because we removed sym link before link checking started . So to avoid this case I excluded that reference from link checker.so basically it's not about excluding file to be checked in link checker, it's about excluding the reference to be link checked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried excluding file using --exclude-path and --exclude-file , but it's excluding both readme files. So removing sym link may be the only option. At the end of link checking , I added sym link again so that it won't effect other workflow.