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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

馃摉 Add dead link linter github workflow #5409

Merged
merged 2 commits into from
Oct 13, 2021
Merged

馃摉 Add dead link linter github workflow #5409

merged 2 commits into from
Oct 13, 2021

Conversation

CecileRobertMichon
Copy link
Contributor

What this PR does / why we need it: Add dead link linter github workflow and fix some dead links. This github action fails on broken links when *.md files are modified.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 7, 2021
fabriziopandini
fabriziopandini reviewed Oct 8, 2021
View reviewed changes
docs/book/src/introduction.md Outdated Show resolved Hide resolved
docs/book/src/tasks/experimental-features/cluster-classes.md
@@ -61,7 +61,7 @@ The ClusterClass - first in the yaml below - contains references to the template
* DockerMachineTemplate
* KubeadmConfigTemplate

The full ClusterClass definition can also be found in the [CAPI repo](https://raw.githubusercontent.com/kubernetes-sigs/cluster-api/main/docs/book/src/tasks/yamls/clusterclass.yaml).
The full ClusterClass definition can also be found in the [CAPI repo](https://raw.githubusercontent.com/kubernetes-sigs/cluster-api/main/docs/book/src/tasks/experimental-features/yamls/clusterclass.yaml).
Copy link
Member

Choose a reason for hiding this comment

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

Links in this page are also being fixed in #5390, which is stuck due to CLA issues

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm happy to let #5390 merge first if we can resolve the CLA issue. I had to fix all of them in here to get the test green.

@sbueringer
Copy link
Member

sbueringer commented Oct 11, 2021 •
edited

@CecileRobertMichon Is the linkcheck mandatory for merge?

Mostly asking because something like the ClusterClass quickstart would then require two PRs (one to add the YAMLs and one to add the quickstart with the links to https://raw.githubusercontent.com/...) or an manual merge by a repo admin. (Even if that is the case I would still perfer having the linter, just asking out of curiosity)

@CecileRobertMichon
Copy link
Contributor Author

@sbueringer right now it is not required. Once the PR merges, we can make it required (or not) from Github settings.

@sbueringer
Copy link
Member

@CecileRobertMichon And tide takes that information from the Github settings when it decides to merge?

@CecileRobertMichon
Copy link
Contributor Author

@sbueringer correct

https://github.com/kubernetes/test-infra/blob/master/prow/cmd/tide/config.md#context-policy-options

vincepri
vincepri approved these changes Oct 13, 2021
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 13, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 Oct 13, 2021
@k8s-ci-robot k8s-ci-robot merged commit 0caa40d into kubernetes-sigs:main Oct 13, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Oct 13, 2021
@CecileRobertMichon CecileRobertMichon mentioned this pull request Oct 13, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabriziopandini fabriziopandini fabriziopandini left review comments

@vincepri vincepri vincepri approved these changes

@sbueringer sbueringer Awaiting requested review from sbueringer

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@vincepri vincepri

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@CecileRobertMichon @sbueringer @k8s-ci-robot @vincepri @fabriziopandini