From 2fe8b0a496661f3dedb6dfedc06dcfa8cee4b888 Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Mon, 21 Aug 2023 12:17:38 -0400 Subject: [PATCH 1/3] Test link-checker-gpt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR implements: * https://github.com/kingdonb/link-checker-gpt/tree/v1-beta#integration-as-a-ci-check I'm testing the new Dockerized version of the link-checker-gpt, that helped us fix all the broken links in #1573 It should be possible to merge this if we are happy with it, independent of the release for Flux v2.1 (it can certainly wait until after 👍) I'm going to push a broken link as a test. There has been some thought put into making a good workflow in a way such that we don't want to 86 it right away... minor annoyances should all be squashed prior to their annoying anyone * add the workflow to .github/workflows * fix the bug (upstream) * provide GH_TOKEN to link checker * (fix github token) Signed-off-by: Kingdon Barrett --- .github/workflows/link-checker.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/link-checker.yml diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml new file mode 100644 index 000000000..c8276b033 --- /dev/null +++ b/.github/workflows/link-checker.yml @@ -0,0 +1,26 @@ +name: Link Checker + +on: + pull_request: + branches: + - main + + # eventually: (to write comments) +# permissions: +# pull-requests: write + +jobs: + check-links: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Link Checker GPT + uses: kingdonb/link-checker-gpt@v1-beta # (the v1 tag is still unreleased, we need to test) + with: + productionDomain: fluxcd.io + previewDomain: deploy-preview-${{ github.event.pull_request.number }}--fluxcd.netlify.app + prNumber: ${{ github.event.pull_request.number}} + githubToken: ${{ secrets.GITHUB_TOKEN }} From 054e7b4e46c2830aecbe225dc09932682ca1ad48 Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Mon, 21 Aug 2023 14:32:01 -0400 Subject: [PATCH 2/3] This commit should fail Add a bad link id anchor that doesn't go anywhere (but isn't a 404) Signed-off-by: Kingdon Barrett --- content/en/flux/flux-e2e.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/flux/flux-e2e.md b/content/en/flux/flux-e2e.md index 2013a0652..52085d2b3 100644 --- a/content/en/flux/flux-e2e.md +++ b/content/en/flux/flux-e2e.md @@ -11,7 +11,7 @@ Note that this guide has not been updated since more than a year ago. It does no Expect this doc to receive an overhaul soon. {{% /alert %}} -Below we describe the flow of data through Flux, from End to End. +below we describe the flow of data through flux, from end to end. [here is a link that doesn't go anywhere](#id-anchor-failure) We assume a standard Flux installation, with all optional features enabled, then explain how Flux users can expect their change to flow through the stages of its life as a commit, and describe how the commit data passes through the Flux system and the cluster, in rough chronological order. We tried to cover From 54ab90f4e8e5b0540242d4df9069d61bb85d4307 Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Mon, 21 Aug 2023 15:23:45 -0400 Subject: [PATCH 3/3] Revert "This commit should fail" This reverts commit 6ffc7565eebf050ddb73111c6be0871798cb732d. Signed-off-by: Kingdon Barrett --- content/en/flux/flux-e2e.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/flux/flux-e2e.md b/content/en/flux/flux-e2e.md index 52085d2b3..2013a0652 100644 --- a/content/en/flux/flux-e2e.md +++ b/content/en/flux/flux-e2e.md @@ -11,7 +11,7 @@ Note that this guide has not been updated since more than a year ago. It does no Expect this doc to receive an overhaul soon. {{% /alert %}} -below we describe the flow of data through flux, from end to end. [here is a link that doesn't go anywhere](#id-anchor-failure) +Below we describe the flow of data through Flux, from End to End. We assume a standard Flux installation, with all optional features enabled, then explain how Flux users can expect their change to flow through the stages of its life as a commit, and describe how the commit data passes through the Flux system and the cluster, in rough chronological order. We tried to cover