Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🌱 Use quiet mode on markdown link checker #6167

Merged
merged 1 commit into from
Feb 17, 2022
Merged

🌱 Use quiet mode on markdown link checker #6167

merged 1 commit into from
Feb 17, 2022

Conversation

killianmuldoon
Copy link
Contributor

This updates the markdown lint checker config to only produce errors.

Fixes #

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 17, 2022
@sbueringer
Copy link
Member

That would be an outstanding improvement :)

@killianmuldoon
Copy link
Contributor Author

The quiet mode still spits out each file its checking, but it no longer produces the full list of links which is an improvement, but not ideal: https://github.com/kubernetes-sigs/cluster-api/runs/5234540056?check_suite_focus=true

killianmuldoon
killianmuldoon commented Feb 17, 2022
View reviewed changes
docs/book/src/user/quick-start.md Outdated
@@ -6,7 +6,7 @@ In this tutorial we'll cover the basics of how to use Cluster API to create one

<h1>Warning</h1>

If using a [provider] that does not support v1beta1 or v1alpha4 yet, please follow the [release 0.3](https://release-0-3.cluster-api.sigs.k8s.io/user/quick-start.html) or [release 0.4](https://release-0-4.cluster-api.sigs.k8s.io/user/quick-start.html) quickstart instructions instead.
If using a [provider] that does not support v1beta1 or v1alpha4 yet, please follow the [release 0.3](https://-0-3.cluster-api.sigs.k8s.io/user/quick-start.html) or [release 0.4](https://release-0-4.cluster-api.sigs.k8s.io/user/quick-start.html) quickstart instructions instead.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Breaking a link here just to test the output from the ci job.

@sbueringer
Copy link
Member

Not sure how it looked before, but that looks easily grepp'able

ERROR: 1 dead links found!
[✖] https://-0-3.cluster-api.sigs.k8s.io/user/quick-start.html → Status: 0

@killianmuldoon
Copy link
Contributor Author

I think this is the best we'll get without updating the JS code and picking up a new linter. WDYT about merging this for now as it makes the output more readable?

@killianmuldoon killianmuldoon changed the title WIP use quiet mode on markdown link checker 🌱 Use quiet mode on markdown link checker Feb 17, 2022
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 17, 2022
@sbueringer
Copy link
Member

I think this is the best we'll get without updating the JS code and picking up a new linter. WDYT about merging this for now as it makes the output more readable?

Easily a big improvement. So +1 from my side
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 17, 2022
@sbueringer
Copy link
Member

cc @CecileRobertMichon

@stmcginnis
Copy link
Contributor

/lgtm

Good call!

@CecileRobertMichon
Copy link
Contributor

/lgtm
/approve

Definitely better

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 17, 2022
@k8s-ci-robot k8s-ci-robot merged commit adb9a63 into kubernetes-sigs:main Feb 17, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

@vincepri vincepri Awaiting requested review from vincepri

Assignees

@stmcginnis stmcginnis

@sbueringer sbueringer

@CecileRobertMichon CecileRobertMichon

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
v1.2
Development

Successfully merging this pull request may close these issues.
5 participants
@killianmuldoon @sbueringer @stmcginnis @CecileRobertMichon @k8s-ci-robot