Update actions for 1.5 and make names consistent

killianmuldoon · killianmuldoon · commit c3ffe4952fef · 2023-08-03T16:28:33.000+01:00
Signed-off-by: killianmuldoon &lt;kmuldoon@vmware.com&gt;
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
diff --git a/.github/workflows/pr-dependabot.yaml b/.github/workflows/pr-dependabot.yaml
@@ -1,5 +1,6 @@
-name: dependabot
+name: PR dependabot code generation and go modules fix
 
+# This action runs on other PRs opened by dependabot. It updates modules and generated code on PRs opened by dependabot.
 on:
   pull_request:
     branches:
diff --git a/.github/workflows/pr-golangci-lint.yaml b/.github/workflows/pr-golangci-lint.yaml
@@ -1,4 +1,4 @@
-name: golangci-lint
+name: PR golangci-lint
 
 on:
   pull_request:
diff --git a/.github/workflows/pr-md-link-check.yaml b/.github/workflows/pr-md-link-check.yaml
@@ -1,4 +1,4 @@
-name: Check PR Markdown links
+name: PR check Markdown links
 
 on:
   pull_request:
diff --git a/.github/workflows/pr-verify.yaml b/.github/workflows/pr-verify.yaml
@@ -1,4 +1,4 @@
-name: verify
+name: PR verify
 
 on:
   pull_request_target:
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
diff --git a/.github/workflows/weekly-image-scan.yaml b/.github/workflows/weekly-image-scan.yaml
@@ -1,4 +1,4 @@
-name: scan-images
+name: Weekly image scan
 
 on:
   schedule:
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        branch: [ main, release-1.4, release-1.3 ]
+        branch: [ main, release-1.5, release-1.4 ]
     name: Trivy
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/weekly-md-link-check.yaml b/.github/workflows/weekly-md-link-check.yaml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        branch: [ main, release-1.4, release-1.3 ]
+        branch: [ main, release-1.5, release-1.4 ]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3
diff --git a/.github/workflows/weekly-test-release.yaml b/.github/workflows/weekly-test-release.yaml
@@ -1,7 +1,7 @@
-name: Release test
+name: Weekly release test
 
-# Note: This workflow does not build for releases. It attempts to build release binaries daily to ensure the repo
-# is in a good state.
+# Note: This workflow does not build for releases. It attempts to build release binaries periodically to ensure the repo
+# release machinery is in a good state.
 
 on:
   schedule:
@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        branch: [ main, release-1.4, release-1.3 ]
+        branch: [ main, release-1.5, release-1.4 ]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3
diff --git a/Makefile b/Makefile
@@ -160,7 +160,7 @@ GINKGO := $(abspath $(TOOLS_BIN_DIR)/$(GINKGO_BIN)-$(GINGKO_VER))
 GINKGO_PKG := github.com/onsi/ginkgo/v2/ginkgo
 
 GOLANGCI_LINT_BIN := golangci-lint
-GOLANGCI_LINT_VER := $(shell cat .github/workflows/golangci-lint.yml | grep [[:space:]]version: | sed 's/.*version: //')
+GOLANGCI_LINT_VER := $(shell cat .github/workflows/pr-golangci-lint.yaml | grep [[:space:]]version: | sed 's/.*version: //')
 GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER))
 GOLANGCI_LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
 
diff --git a/docs/book/src/reference/jobs.md b/docs/book/src/reference/jobs.md
@@ -37,23 +37,27 @@ Prow Presubmits:
   * [pull-cluster-api-e2e-scale-main-experimental] `./scripts/ci-e2e-scale.sh`
 
 GitHub Presubmit Workflows:
-* golangci-lint: golangci/golangci-lint-action
+* PR golangci-lint: golangci/golangci-lint-action
   * Runs golangci-lint. Can be run locally via `make lint`.
-* verify: kubernetes-sigs/kubebuilder-release-tools verifier
+* PR verify: kubernetes-sigs/kubebuilder-release-tools verifier
   * Verifies the PR titles have a valid format, i.e. contains one of the valid icons.
   * Verifies the PR description is valid, i.e. is long enough.
-* Check PR Markdown links (run when markdown files changed)
-  * Checks markdown for broken links.
-* dependabot (run on dependabot PRs)
+* PR check Markdown links (run when markdown files changed)
+  * Checks markdown modified in PR for broken links.
+* PR dependabot (run on dependabot PRs)
   * Regenerates Go modules and code.
-* release (run on tags)
-  * Creates a GitHub release with release notes for the tag.
 
 GitHub Weekly Workflows:
-* golangci-lint: golangci/golangci-lint-action
-  * Weekly check all Markdown links
-* scan-images:
+* Weekly check all Markdown links
+  * Checks markdown across the repo for broken links.
+* Weekly image scan:
   * Scan all images for vulnerabilities. Can be run locally via `make verify-container-images`
+* Weekly release test:
+  * Test the the `release` make target is working without errors.
+  
+Other Github workflows
+* release (runs when tags are pushed)
+  * Creates a GitHub release with release notes for the tag.
 
 ### Postsubmits
 
diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md
@@ -426,7 +426,7 @@ While we add test coverage for the new release branch we will also drop the test
 3. Remove tests for old release branches according to our policy documented in [Support and guarantees](../../CONTRIBUTING.md#support-and-guarantees)
    For example, let's assume we just created tests for v1.4, then we can now drop test coverage for the release-1.1 branch.
 4. Verify the jobs and dashboards a day later by taking a look at: `https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-1.4`
-5. Update `.github/workflows/scan.yml` - to setup Trivy scanning - `.github/workflows/lint-docs-weekly.yml` - to setup link checking in the CAPI book - and `.github/workflows/test-release-weekly.yml` - to verify the release target is working - for the currently supported branches.
+5. Update `.github/workflows/weekly-image-scan.yaml` - to setup Trivy scanning - `.github/workflows/weekly-md-link-check.yaml` - to setup link checking in the CAPI book - and `.github/workflows/weekly-test-release.yaml` - to verify the release target is working - for the currently supported branches.
 
 
 Prior art:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: golangci-lint`
	`1`	`+name: PR golangci-lint`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`pull_request:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Check PR Markdown links`
	`1`	`+name: PR check Markdown links`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`pull_request:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: verify`
	`1`	`+name: PR verify`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`pull_request_target:`