🌱 book: refactor verification

[sbueringer]

Signed-off-by: Stefan Büringer [email protected]

What this PR does / why we need it:
This PR refactors our book verification/build as described in #6141.

The verify-book-links target never really verified book links in the sense of checking for broken links.

After this PR we have make book-build target which is run on PRs as part of the build job.

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

[sbueringer]

/assign @CecileRobertMichon

[sbueringer]

/cherry-pick release-1.1
As described on the issue. Let's implement this for main and release-1.1 and keep older branches as is.

[k8s-infra-cherrypick-robot]

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.1 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.1
As described on the issue. Let's implement this for main and release-1.1 and keep older branches as is.

Instructions 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/test-infra repository.

[killianmuldoon]

For some reason this doesn't seem to work for me with make -C docs/book build but it's throwing errors when I run the link checker in standalone mode. Any ideas why? (The older verify target has the same behaviour)

[sbueringer]

For some reason this doesn't seem to work for me with make -C docs/book build but it's throwing errors when I run the link checker in standalone mode. Any ideas why? (The older verify target has the same behaviour)

What are you running, in which sense doesn't it work?
What do you mean with link checker in standalone mode?

This PR drops the verify target because it never really was a link checker, it just built the book :)

Our actual link checker is run as GitHub action (lint-docs.yaml)

[killianmuldoon]

Right - that's what I was missing. I can run ./hack/tools/bin/mdbook-linkcheck --standalone docs/book/ locally to check the links in the book.

[killianmuldoon]

/lgtm

[sbueringer]

Right - that's what I was missing. I can run ./hack/tools/bin/mdbook-linkcheck --standalone docs/book/ locally to check the links in the book.

A nice info, another linkchecker, I wasn't aware of that one :)

@CecileRobertMichon What do you think, should we keep that one or remove it too?

/hold
for a bit

[killianmuldoon]

This one is installed in that make target I'm pretty sure

[sonasingh46]

Here is one thought:

• Make a target that actually checks for book links.
• Use that target itself in the CI.

[sbueringer]

Here is one thought:

• Make a target that actually checks for book links.
• Use that target itself in the CI.

In general +1. It just seems like the GitHub action we have works pretty nicely. So I'm not sure if we should built a target which does the same as the GithubAction and then run make as a GithubAction.

Maybe we should keep the GitHub action as is and add a target which does the same as the action? (tl;dr I'm not sure if it's worth enforcing to run make in CI as GitHub actions are usually nicely integrated with GitHub, e.g. see the nicely minimal GitHub action config)

[sonasingh46]

+1 @sbueringer

[sbueringer]

Dropped the other linkchecker too.

Ashutosh and I talked somewhere in Slack, the idea would be for now to only have the GitHub action as linkchecker. If there is demand we can always add a new make target to make it locally runnable. But up until now that wasn't really necessary.

[sbueringer]

/cc @fabriziopandini

[vincepri]

/lgtm

[fabriziopandini]

/approve
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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:

• OWNERS [fabriziopandini]

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

[sbueringer]

/hold cancel

[k8s-infra-cherrypick-robot]

@sbueringer: #6159 failed to apply on top of branch "release-1.1":

Applying: book: refactor verification
Using index info to reconstruct a base tree...
M	Makefile
Falling back to patching base and 3-way merge...
Auto-merging Makefile
CONFLICT (content): Merge conflict in Makefile
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 book: refactor verification
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.1
As described on the issue. Let's implement this for main and release-1.1 and keep older branches as is.

Instructions 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/test-infra repository.

[sbueringer]

manual cherry-pick: #6204