ci: Weekly check whether the docs url is alive #2482

Bevisy · 2021-08-23T09:47:07Z

Weekly check(at 23:00 every Sunday) whether the docs url is ALIVE, so that
we can find the failed url in time

Fixes #815

Signed-off-by: Binbin Zhang binbin36520@gmail.com

devimc · 2021-08-23T14:26:35Z

thanks @Bevisy
cc @jodh-intel

.github/workflows/static-check-docs.yaml

fidencio · 2021-08-31T08:08:12Z

@Bevisy, sorry for coming late to the party, but why having those checked on weekly basis and not on every PR?

Bevisy · 2021-08-31T08:16:16Z

@Bevisy, sorry for coming late to the party, but why having those checked on weekly basis and not on every PR?

I can't agree more to add docs check to static-checks ci workflow. Periodic examination results are not sufficiently visual.

Bevisy · 2021-08-31T09:29:37Z

I've changed from periodic checks to triggering checks on every pr push and only triggering checks on all *.md documents when they are modified.
The execution time of doc check once for a local test is as follows:

make static-check-docs  5.81s user 2.01s system 2% cpu 5:35.94 total

If pr does not contain document changes, the execution time as follows:

make static-check-docs  0.71s user 0.23s system 10% cpu 9.346 total

It can be concluded that the ci time consumption brought is tolerable.

jodh-intel

Thanks @Bevisy!

lgtm

It's worth noting that it might still be worth running this check periodically as well. It's just about possible that we might not get any new PRs for a few days, but if we ran the checks daily, we would detect broken URLs faster. That said, it's more CI time and more complexity so this is fine for now 😄

jodh-intel · 2021-09-02T13:52:51Z

/test

Bevisy · 2021-09-06T09:14:22Z

Hi, @jodh-intel @fidencio , I found workflow/static-checks always execute docs check if file changed

$ /home/zbb/go/src/github.com/kata-containers/tests/.ci/static-checks.sh src/runtime
[static-checks.sh:1148] INFO: Running 'static_check_commits' function
make -C cmd/checkcommits
make[1]: Entering directory '/home/zbb/go/src/github.com/kata-containers/tests/cmd/checkcommits'
go test .
ok      github.com/kata-containers/tests/cmd/checkcommits       (cached)
go install -ldflags "-X main.appCommit="2b71534dcb403a2341db35ce87a12ff62af793dc" -X main.appVersion=0.0.1" .
make[1]: Leaving directory '/home/zbb/go/src/github.com/kata-containers/tests/cmd/checkcommits'
From github.com:kata-containers/tests
 = [up to date]        main       -> origin/main
Running checkcommits version 0.0.1 (commit 2b71534dcb403a2341db35ce87a12ff62af793dc)
Found 1 commit between commit HEAD and branch main
All commit checks passed.
[static-checks.sh:1148] INFO: Running 'static_check_docs' function
[static-checks.sh:608] INFO: Checking documentation
[static-checks.sh:626] INFO: Checking local branch for changed documents only
[static-checks.sh:663] INFO: Checking document markdown references
...

So it means that adding new step/static-doc-check is a duplicate step. Maybe we should add new workflow to check all docs url periodically just as we expected at the beginning

I will do some fix later 😄

Bevisy · 2021-09-14T08:24:39Z

I have updated the fix. And when the docks-url-alive-check workflow excuted, we could find there two url dead

ERROR: Invalid URL 'https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/filesystems/dax.txt' found in the following files:

docs/design/architecture.md
ERROR: Invalid URL 'https://projectacrn.github.io/latest/tutorials/kbl-nuc-sdc.html#use-the-script-to-set-up-acrn-automatically' found in the following files:

docs/how-to/how-to-use-kata-containers-with-acrn.md

The dead url should update to

https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/filesystems/dax.rst

https://projectacrn.github.io/2.1/tutorials/kbl-nuc-sdc.html#use-the-script-to-set-up-acrn-automatically

Bevisy · 2021-09-14T08:47:54Z

/test

jodh-intel · 2021-10-18T13:01:48Z

/test

jodh-intel · 2021-10-29T14:06:09Z

/test-ubuntu-qat

jodh-intel · 2021-10-29T14:06:23Z

Any further comments @bergwolf?

cmaf · 2021-11-09T04:21:47Z

@Bevisy could you please rebase?

jodh-intel

Thanks @Bevisy.

lgtm

jodh-intel · 2021-12-23T12:06:29Z

@fidencio - could you tal at this one?

amshinde · 2021-12-23T17:24:04Z

.github/workflows/docs-url-alive-check.yaml

+      target_branch: ${{ github.base_ref }}
+    steps:
+    - name: Install Go
+      if: ${{ !contains(github.event.pull_request.labels.*.name, 'force-skip-ci') }}


I see that you are using this check at every step. Why not just check this once as the first step and return early if true.

@Bevisy Can you address this so that we can have this PR merged?

I'm sorry I don't see the syntax for this feature on github action, it looks like the steps can only be executed one at a time in sequence

.github/workflows/docs-url-alive-check.yaml

jodh-intel · 2022-01-10T10:04:47Z

Ping for a review y'all!

Weekly check(at 23:00 every Sunday) whether the docs url is ALIVE, so that we can find the failed url in time Fixes kata-containers#815 Signed-off-by: Binbin Zhang <binbin36520@gmail.com>

amshinde · 2022-01-20T13:52:57Z

/test

Bevisy · 2022-01-24T14:10:07Z

Hold on, we can't simply remove the Travis-related environment variables, but need to do further investigation. I will do some cleaning under issue #3544 and then re-update the validation workflow here.

fidencio · 2022-01-26T12:42:20Z

A head's up that may affect your PR.

In the Architecture Committee meeting from January 25th, 2022, the Architecture Committee has agreed on using the "Dismiss stale pull request approvals when new commits are pushed" configuration from GitHub. It basically means that if your PR has been rebased or updated, the approvals given will be erased.

In order to minimize traumas due to the new approach, please, consider adding a note on the changes done before the rebase / force-push, and also pinging the reviewers for a subsequent round of reviews.

Thanks for your understanding!

Related issue: kata-containers/community#249

fidencio · 2022-02-01T09:16:38Z

Adding the do-not-merge label as per @Bevisy's comment.

jodh-intel

Thanks @Bevisy!

lgtm

jodh-intel · 2022-02-14T10:56:05Z

@Bevisy - Could you fix those invalid URL's the checker found on another commit on this PR maybe?

jodh-intel · 2022-03-10T11:46:00Z

Weighing up the duplication versus the ability to check all our docs daily, I say let's land this!

inter-step comms and skips are extremely awkward with GHA's, so if that language every grows the ability to do what we want in a simpler way, we can iterate this GHA later imho.

jodh-intel · 2022-03-10T11:46:23Z

Ping for more reviews folks...

jodh-intel · 2022-03-21T10:51:35Z

Can we get one more review here please?

Jakob-Naucke

LGTM. OOI where would we see an unsuccessful run? It wouldn't be in the PRs, right?

Bevisy · 2022-03-21T11:09:54Z

LGTM. OOI where would we see an unsuccessful run? It wouldn't be in the PRs, right?

We can see the results of the execution in the actions. We don't get email notifications, so we need to check the results of the actions periodically.

fidencio · 2022-03-21T13:03:39Z

/test-ppc64le

fidencio · 2022-03-21T13:03:54Z

/test-ppc

fidencio · 2022-03-21T14:16:07Z

/test-power

jodh-intel · 2022-03-21T14:19:26Z

To give a bit of context to this PR:

The static-checks.sh script currently checks all URLs in all documents that a PR modifies.
This PR adds a GHA that would check all URLs in all Kata documents every week.
Checking doc URLs is necessary since URLs expire / die / get changed all the time, so to ensure our docs are as up-to-date as possible, we need to check all URLs as regularly as possible (I think we might want to consider daily at some point, but let's keep an eye on this GHA when it lands to see if we need to run it more regularly).
In theory, we could make the static-checks.sh script check all Kata documents when a PR is raised (not just those modified by a PR). However, the problem is that in practise we hit the dreaded GitHub API rate limit.
The solution to that problem is to run the checker in the CI as an authenticated user if someone has free cycles to look at this:

Use authentication when checking GitHub URLs in static check script tests#4304

Bevisy force-pushed the main-815 branch from 78a6a93 to b094c97 Compare August 23, 2021 11:51

Bevisy changed the title ~~makefile: Schedule daily static checking docs~~ makefile: Schedule static check docs weekly Aug 23, 2021

Bevisy force-pushed the main-815 branch from b094c97 to 3bb2454 Compare August 23, 2021 11:55

bergwolf reviewed Aug 31, 2021

View reviewed changes

.github/workflows/static-check-docs.yaml Outdated Show resolved Hide resolved

.github/workflows/static-check-docs.yaml Outdated Show resolved Hide resolved

Bevisy force-pushed the main-815 branch 3 times, most recently from b9c55ca to 5eb44d2 Compare August 31, 2021 08:05

Bevisy force-pushed the main-815 branch from 5eb44d2 to fb2515b Compare August 31, 2021 09:23

Bevisy changed the title ~~makefile: Schedule static check docs weekly~~ ci: Add docs check to workflows/static-checks Aug 31, 2021

Bevisy force-pushed the main-815 branch from fb2515b to 440a91a Compare August 31, 2021 09:41

Bevisy mentioned this pull request Aug 31, 2021

Create GitHub action to check documentation URLs #815

Closed

jodh-intel approved these changes Sep 2, 2021

View reviewed changes

Bevisy force-pushed the main-815 branch 2 times, most recently from 2d054b1 to f4fb9ed Compare September 14, 2021 08:18

Bevisy changed the title ~~ci: Add docs check to workflows/static-checks~~ ci: Weekly check whether the docs url is alive Sep 14, 2021

Bevisy mentioned this pull request Sep 14, 2021

fix outdated links which were checked out by workflow/docs-url-alive-check #2630

Closed

Bevisy force-pushed the main-815 branch from f4fb9ed to 489bdd6 Compare September 14, 2021 08:46

Bevisy force-pushed the main-815 branch from 489bdd6 to bb3b610 Compare September 14, 2021 09:22

jodh-intel previously approved these changes Dec 23, 2021

View reviewed changes

amshinde reviewed Dec 23, 2021

View reviewed changes

ci: Weekly check whether the docs url is alive

168fadf

Weekly check(at 23:00 every Sunday) whether the docs url is ALIVE, so that we can find the failed url in time Fixes kata-containers#815 Signed-off-by: Binbin Zhang <binbin36520@gmail.com>

Bevisy force-pushed the main-815 branch from b173db2 to 168fadf Compare January 20, 2022 11:56

Bevisy mentioned this pull request Jan 24, 2022

Remove or modify all Travis CI-related workflow steps #3544

Closed

fidencio dismissed jodh-intel’s stale review via 168fadf January 26, 2022 11:57

fidencio added the do-not-merge PR has problems or depends on another label Feb 1, 2022

jodh-intel approved these changes Feb 14, 2022

View reviewed changes

katacontainersbot added the size/medium Average sized task label Mar 9, 2022

jodh-intel removed the do-not-merge PR has problems or depends on another label Mar 10, 2022

Jakob-Naucke approved these changes Mar 21, 2022

View reviewed changes

Jakob-Naucke added area/testing Issues related to testing no-backport-needed labels Mar 21, 2022

fidencio merged commit aa6886f into kata-containers:main Mar 21, 2022

Bevisy deleted the main-815 branch June 16, 2022 06:57

ci: Weekly check whether the docs url is alive #2482

ci: Weekly check whether the docs url is alive #2482

Conversation

Bevisy commented Aug 23, 2021 • edited

devimc commented Aug 23, 2021

fidencio commented Aug 31, 2021

Bevisy commented Aug 31, 2021

Bevisy commented Aug 31, 2021 • edited

jodh-intel left a comment

Choose a reason for hiding this comment

jodh-intel commented Sep 2, 2021

Bevisy commented Sep 6, 2021 • edited

Bevisy commented Sep 14, 2021 • edited

Bevisy commented Sep 14, 2021

jodh-intel commented Oct 18, 2021

jodh-intel commented Oct 29, 2021

jodh-intel commented Oct 29, 2021

cmaf commented Nov 9, 2021

jodh-intel left a comment

Choose a reason for hiding this comment

jodh-intel commented Dec 23, 2021

amshinde Dec 23, 2021

Choose a reason for hiding this comment

Jakob-Naucke Jan 13, 2022

Choose a reason for hiding this comment

amshinde Jan 20, 2022

Choose a reason for hiding this comment

Bevisy Jan 20, 2022

Choose a reason for hiding this comment

jodh-intel commented Jan 10, 2022

amshinde commented Jan 20, 2022

Bevisy commented Jan 24, 2022

fidencio commented Jan 26, 2022

fidencio commented Feb 1, 2022

jodh-intel left a comment

Choose a reason for hiding this comment

jodh-intel commented Feb 14, 2022

jodh-intel commented Mar 10, 2022

jodh-intel commented Mar 10, 2022

jodh-intel commented Mar 21, 2022

Jakob-Naucke left a comment

Choose a reason for hiding this comment

Bevisy commented Mar 21, 2022

fidencio commented Mar 21, 2022

fidencio commented Mar 21, 2022

fidencio commented Mar 21, 2022

jodh-intel commented Mar 21, 2022

Bevisy commented Aug 23, 2021 •

edited

Bevisy commented Aug 31, 2021 •

edited

Bevisy commented Sep 6, 2021 •

edited

Bevisy commented Sep 14, 2021 •

edited