Deprecation Notice: Replace deprecated gaurav-nelson/github-action-markdown-link-check

[Okabe-Junya]

/kind cleanup

Background

About two weeks ago, gaurav-nelson/github-action-markdown-link-check was marked as deprecated:

cf. https://github.com/gaurav-nelson/github-action-markdown-link-check

This repository is now ⛔️ deprecated and is no longer actively maintained.
For support and further development, please use the maintained fork available at Tcort GitHub Action Markdown Link Check.

Since this repository currently uses gaurav-nelson/github-action-markdown-link-check, we need to clean it up appropriately.

cluster-api/.github/workflows/pr-md-link-check.yaml

Line 18 in c8d8f4e

- uses: gaurav-nelson/github-action-markdown-link-check@3c3b66f1f7d0900e37b71eca45b63ea9eedfce31 # tag=1.0.17

cluster-api/.github/workflows/weekly-md-link-check.yaml

Line 23 in c8d8f4e

- uses: gaurav-nelson/github-action-markdown-link-check@3c3b66f1f7d0900e37b71eca45b63ea9eedfce31 # tag=1.0.17

While the forked at tcort/github-action-markdown-link-check is suggested, it may still be too early to rely on that action.

Question:

How should we handle this deprecation in our workflow?

[Okabe-Junya]

xref.

• Deprecation Notice: Replace deprecated gaurav-nelson/github-action-markdown-link-check cluster-api-provider-azure#5598
• Deprecation Notice: Replace deprecated gaurav-nelson/github-action-markdown-link-check cluster-api-provider-vsphere#3445

[Okabe-Junya]

/area ci

[sivchari]

It seems like to be just shell scripts.
Just an idea, we can still be using it by just moving it to this repo, then pass the argument to the script, then, as a by-product, the workflow will become shell script, so we can easily debug on local machine.

What do you think?
/cc @fabriziopandini @chrischdi

[Okabe-Junya]

I agree that this workflow is nothing more than a shell script. We could implement such a script ourselves as needed (right away).

Looking at the CodeSearch results, the same action is used in several repos.

• FYI: https://cs.k8s.io/?q=gaurav-nelson%2Fgithub-action-markdown-link-check&i=nope&literal=nope&files=&excludeFiles=&repos=

One of the great things about GitHub Actions is reusable workflows — we can easily use a workflow in other repositories.
Rather than duplicating this small, identical script across each repo, it would be nice to have some reusable mechanism.

Do you have any good ideas?

[sivchari]

Hey @Okabe-Junya
I've made the workflow to check markdown link by using linkspector that is alternative tool of markdown-link-check.
This workflow can work expectedly. PTAL 🙏
#12146

[chrischdi]

Does kubernetes (e.g. website) have a link checker we could migrate to?

Maybe worth asking in sig-docs?

[chrischdi]

/priority backlog

[chrischdi]

/triage accepte

[k8s-ci-robot]

@chrischdi: The label(s) triage/accepte cannot be applied, because the repository doesn't have them.

In response to this:

/triage accepte

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-sigs/prow repository.

[chrischdi]

/triage accepted

[chrischdi]

/help

[k8s-ci-robot]

@chrischdi:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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-sigs/prow repository.

[Okabe-Junya]

Does kubernetes (e.g. website) have a link checker we could migrate to?

Maybe worth asking in sig-docs?

As far as I know, there isn't any.

Since I'm not familiar with popular OSS for link checkers, it would be beneficial for the community to have a reusable script (like reusable GitHub Actions).
It could be worth investigating how CNCF org or other CNCF communities are handling this issue

[sbueringer]

As far as I know, there isn't any.

Let's ask please if we're not 100% sure