search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.44k stars 14.3k forks source link

Perform Automated Link Checking Periodically #22489

Open irvifa opened 4 years ago

irvifa commented 4 years ago

This is a Feature Request

In order to provide more up to date link checking, it'll be helpful if we can do automated link checking periodically so whenever we found outdated/dead links we can fixed it immediately.

What would you like to be added

To be able to support this, since we already have this Makefile we can try to run this periodically probably using CronJob or other available infrastructure.

Why is this needed

Comments

It'll help us fixed outdated/dead links we can fixed it immediately.

irvifa commented 4 years ago

/priority important-longterm

irvifa commented 4 years ago

/cc @kubernetes/sig-testing I included sig-testing here since we will need advice on how to perform periodic test.

irvifa commented 4 years ago

/cc @kubernetes/sig-docs-en-owners

BenTheElder commented 4 years ago

https://github.com/kubernetes/test-infra/tree/master/prow#getting-started periodic job type runs periodically.

irvifa commented 4 years ago

Thanks @BenTheElder anyway @sftim and @onlydole I’ve checked the periodic jobs on prow https://github.com/kubernetes/test-infra/blob/master/prow/jobs.md however I’m not sure about how often we would like to perform it. Once we agree to the period I’d like to help setup the job.

sftim commented 4 years ago

How about once a week for a proof-of-concept, then the next step would be test every incoming PR (but don't block merges), then we aim to make sure the main branch always passes so we can turn on enforcement for PRs.

?

sftim commented 4 years ago

I think it's (just) fair to label this /sig testing

irvifa commented 4 years ago

@sftim Noted then, thank you.

celestehorgan commented 4 years ago

/area web-development

irvifa commented 4 years ago

@BenTheElder Do you know if there's a way to clone this repo to the prow job? I notice that the repo and branch is only tightly coupled with presubmit/postsubmit

sftim commented 4 years ago

/retitle Perform Automated Link Checking Periodically

sftim commented 4 years ago

Here's a mockup of how I think the status could show up when link checking fails: Mockup

sftim commented 4 years ago

(right now I don't know the magic / code to make that happen though, sorry)

BenTheElder commented 4 years ago

prow cannot do checks currently, due to not being a github app (and the API only being available to apps)

On Tue, Aug 11, 2020 at 11:37 AM Tim Bannister notifications@github.com wrote:

(right now I don't know the magic / code to make that happen though, sorry)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/kubernetes/website/issues/22489#issuecomment-672177948, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHADK5TLXRUEUT4IPPCE3LSAGFV7ANCNFSM4OYR4F7A .

fejta-bot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

onlydole commented 3 years ago

/remove-lifecycle stale

fejta-bot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

onlydole commented 3 years ago

/remove-lifecycle stale

fejta-bot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

fejta-bot commented 3 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten

kbhawkey commented 3 years ago

/remove-lifecyle rotten

BenTheElder commented 3 years ago

@BenTheElder Do you know if there's a way to clone this repo to the prow job? I notice that the repo and branch is only tightly coupled with presubmit/postsubmit

sorry I missed this, yes it's extra_refs. https://github.com/kubernetes/test-infra/blob/master/prow/pod-utilities.md

lots of jobs clone a repo using this if they're not a pre or post submit

k8s-triage-robot commented 3 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community. /close

k8s-ci-robot commented 3 years ago

@k8s-triage-robot: Closing this issue.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-890400075): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >Send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
spiffxp commented 3 years ago

/remove-lifecycle rotten /reopen Noticed someone else had tried removing this label, not sure why it didn't take

k8s-ci-robot commented 3 years ago

@spiffxp: Reopened this issue.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-891001077): >/remove-lifecycle rotten >/reopen >Noticed someone else had tried removing this label, not sure why it didn't take Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot commented 2 years ago

@k8s-triage-robot: Closing this issue.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-1003058260): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages issues and PRs according to the following rules: >- After 90d of inactivity, `lifecycle/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was applied, the issue is closed > >You can: >- Reopen this issue or PR with `/reopen` >- Mark this issue or PR as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
shuuji3 commented 1 year ago

/reopen /assign

k8s-ci-robot commented 1 year ago

@shuuji3: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-1376893293): >/reopen >/assign Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
shuuji3 commented 1 year ago

Hello, I'd like to work on this. 🙂

I already wrote a new GitHub Actions workflow file. The remaining task is only to print out the result as annotation: https://github.com/kubernetes/website/issues/22489#issuecomment-672177256

shuuji3 commented 1 year ago

I'm afraid that I'd like to close this issue for now based on the talk on #38866.

/close /unassign

k8s-ci-robot commented 1 year ago

@shuuji3: Closing this issue.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-1379976748): >I'm afraid that I'd like to close this issue for now based on the talk on #38866. > >/close >/unassign Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
sftim commented 1 year ago

/reopen

It's a valid request even if you don't know how to do this yourself @shuuji3

k8s-ci-robot commented 1 year ago

@sftim: Reopened this issue.

In response to [this](https://github.com/kubernetes/website/issues/22489#issuecomment-1380053905): >/reopen > >It's a valid request even if you don't know how to do this yourself @shuuji3 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
divya-mohan0209 commented 1 year ago

/remove-lifecycle rotten /triage accepted

sftim commented 8 months ago

Also see https://github.com/kubernetes/website/issues/44573

hunshcn commented 8 months ago

Another thing is that htmltest doesn't seem to detect cross-page hash. According to my local test results, none of the 19 error of #44573 are detected... Although checking cross-page hash seems to be supported by htmltest , I use the default configuration under website.