Add link checker to fix broken links in markdown#140
Add link checker to fix broken links in markdown#140farazmd wants to merge 1 commit intokubernetes-sigs:mainfrom
Conversation
k8s-ci-robot
added
the
kind/feature
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: farazmd The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for node-readiness-controller ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
k8s-ci-robot
added
the
cncf-cla: yes
|
Welcome @farazmd! |
k8s-ci-robot
added
the
needs-ok-to-test
|
Hi @farazmd. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
the
size/M
ajaysundark
requested review from
Priyankasaggu11929 and
ajaysundark
and removed request for
SergeyKanzhelev and
tallclair
| darwin-arm64) | ||
| LYCHEE_BASENAME="${LYCHEE_BINARY}-arm64-macos" | ||
| ;; | ||
| windows-amd64) |
There was a problem hiding this comment.
Is there a static lychee binary (built with musl maybe) that we can use for windows-amd64 case (if we are adding it?)
There's also lychee-x86_64-windows.exe in the artifacts.
But overall, I feel like, rather than skipping check for windows-amd64, it should be flagged as unsupported platform in our controller case.
|
|
||
| # Remove artifacts | ||
| rm -rf /tmp/${LYCHEE_BINARY}.${EXT} | ||
| rm -rf /tmp/docs |
There was a problem hiding this comment.
rm -rf /tmp/docs
where are these coming from ^?
| rm -rf /tmp/docs | ||
|
|
||
| # Change back to root directory | ||
| cd "$ROOT_DIR" |
There was a problem hiding this comment.
duplicate?
You're already in ROOT_DIR no?
| LYCHEE_URL="https://github.com/lycheeverse/lychee/releases/download/lychee-v${LYCHEE_VERSION}/${LYCHEE_BASENAME}.${EXT}" | ||
|
|
||
| echo "downloading ${LYCHEE_BASENAME}.${EXT} from ${LYCHEE_URL}" | ||
| set -x | ||
| curl -fL -o /tmp/${LYCHEE_BINARY}.${EXT} "${LYCHEE_URL}" | ||
|
|
||
| ${EXTRACT_CMD} "/tmp/${LYCHEE_BINARY}.${EXT}" |
There was a problem hiding this comment.
let's wrap the binary downloading and extracting with error handling
| LYCHEE_URL="https://github.com/lycheeverse/lychee/releases/download/lychee-v${LYCHEE_VERSION}/${LYCHEE_BASENAME}.${EXT}" | ||
|
|
||
| echo "downloading ${LYCHEE_BASENAME}.${EXT} from ${LYCHEE_URL}" | ||
| set -x |
There was a problem hiding this comment.
I think set -x is not needed in the middle of the script
|
/ok-to-test @farazmd, thanks for the PR. I have left a few in-line comments, and dropping some suggestions below as well. Let's create a temp dir in the beginning of the Also, let's add a |
k8s-ci-robot
added
ok-to-test
3 participants
Description
Added link checker (lychee) to check for broken links in markdown files as part of the verify process.
Also fixed broken links in
README.mdanddocs/book/src/introduction.mdRelated Issue
Fixes #137
Type of Change
/kind feature
Testing
Running make verify - runs the verify-links.sh script
Checklist
make testpassesmake lintpassesDoes this PR introduce a user-facing change?