Merge branch 'main' into upgrades-capa

.abs/main.yaml

@@ -0,0 +1,5 @@
+generate-metadata: true
+chart-dir: ./helm/docs-app
+destination: ./build
+catalog-base-url: https://giantswarm.github.io/giantswarm-operations-platform-catalog/
+replace-chart-version-with-git: true

.circleci/config.yml

@@ -20,9 +20,9 @@ jobs:
         command: |
           container_tag=$(architect project version)
           echo "$container_tag"
-          docker run -d --rm --name docs -p 8080:8080 gsoci.azurecr.io/giantswarm/docs:$container_tag
+          docker run -d --rm --name docs-app -p 8080:8080 gsoci.azurecr.io/giantswarm/docs:$container_tag
 
-          CURL_OUTPUT=$(docker run --link docs gsoci.azurecr.io/giantswarm/curl:7.81.0 curl --no-buffer http://docs:8080)
+          CURL_OUTPUT=$(docker run --link docs-app gsoci.azurecr.io/giantswarm/curl:7.81.0 curl --no-buffer http://docs-app:8080)
           echo $CURL_OUTPUT | grep -q "Giant Swarm"
 
 workflows:
@@ -43,6 +43,7 @@ workflows:
             - master
     - architect/push-to-app-catalog:
         context: architect
+        executor: app-build-suite
         name: push-to-app-catalog
         app_catalog: giantswarm-operations-platform-catalog
         app_catalog_test: giantswarm-operations-platform-test-catalog

.github/pull_request_template.md

@@ -1,10 +1,8 @@
 ### What this PR does / why we need it
 
-<!-- Please mention any GitHub issue, set a descriptive PR title, and use this space for additional explanations. -->
+<!-- Reference a GitHub issue, set a descriptive PR title, and use this space for additional explanations. -->
 
 ### Things to check/remember before submitting
 
-- If you made content changes
-
-    - Run `make lint dev` to render and proofread content changes locally.
-    - Bump `last_review_date` in the front matter header if you reviewed the entire page.
+- If it's one of your first contributions, make sure you've read the [Contributing Guidelines](https://handbook.giantswarm.io/docs/content/docs-guide).
+- Bump `last_review_date` in the front matter header of the pages you've touched.

.github/workflows/check-links-in-prod.yaml

@@ -7,6 +7,11 @@ on:
   schedule:
     - cron: '39 0 20 * *' # every 20th of the month at 00:39
 
+env:
+  # space-separated list of the top-level sections
+  # to check in https://docs.giantswarm.io/{section}/
+  SECTIONS: 'getting-started overview reference support tutorials'
+
 jobs:
   check-links:
     runs-on: ubuntu-latest
@@ -20,127 +25,55 @@ jobs:
           chmod 777 output
 
       - name: check-links-in-overview-pages
-        run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/overview/ \
-            --check-extern \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/overview.html \
-            || echo "failed1=true" >> "$GITHUB_ENV"
+        shell: python {0}
         continue-on-error: true
-
-      - name: check-links-in-getting-started-pages
         run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/getting-started/ \
-            --check-extern \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/getting-started.html \
-            || echo "failed2=true" >> "$GITHUB_ENV"
-        continue-on-error: true
+          import os
+          import subprocess
 
-      - name: check-links-in-tutorials-pages
-        run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/tutorials/ \
-            --check-extern \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/tutorials.html \
-            || echo "failed3=true" >> "$GITHUB_ENV"
-        continue-on-error: true
+          pwd = os.getcwd()
+          sections = os.getenv('SECTIONS').split()
 
-      - name: check-links-in-reference-pages
-        run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/reference/ \
-            --check-extern \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/reference.html \
-             || echo "failed4=true" >> "$GITHUB_ENV"
-        continue-on-error: true
-
-      - name: check-links-in-support-pages
-        run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/support/ \
-            --check-extern \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/support.html \
-            || echo "failed5=true" >> "$GITHUB_ENV"
-        continue-on-error: true
-
-      - name: check-links-in-changelogs
-        run: |
-          docker run --rm --name linkchecker \
-            --volume ${PWD}/output:/workdir --workdir /workdir \
-            ghcr.io/linkchecker/linkchecker:latest \
-            https://docs.giantswarm.io/changes/ \
-            --threads 1 \
-            --recursion-level 2 \
-            --no-status \
-            --file-output html/utf8/changes.html \
-            --ignore-url="^https://github.com/giantswarm/docs/.*" \
-            --ignore-url="^https://.*example\.com/.*" \
-            --ignore-url="^https://my-org\.github\.com/.*" \
-            --ignore-url="^https://github\.com/giantswarm/giantswarm/.*" \
-            --ignore-url=".*gigantic\.io.*" \
-            || echo "failed6=true" >> "$GITHUB_ENV"
-        continue-on-error: true
+          for i, section in enumerate(sections):
+            # call docker run command
+            cmd = ['docker', 'run', '--rm', '--name', 'linkchecker',
+                   '--volume', f'{pwd}/output:/workdir', '--workdir', '/workdir',
+                   'ghcr.io/linkchecker/linkchecker:latest',
+                   f'https://docs.giantswarm.io/{section}/',
+                   '--check-extern',
+                   '--threads', '1',
+                   '--recursion-level', '3',
+                   '--no-status',
+                   '--file-output', f'html/utf8/{section}.html']
+            
+            result = subprocess.run(cmd)
+            if result.returncode > 0:
+              env_file = os.getenv('GITHUB_ENV')
+              with open(env_file, 'a') as f:
+                f.write(f"failed{i}=true\n")
 
       - name: Store reports as artifacts
-        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.2
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
         with:
           name: link-check-reports
           path: ./output
           if-no-files-found: warn
           retention-days: 14
 
       - name: Report errors
+        shell: python {0}
         run: |
-          if [[ $failed1 == "true" ]]; then
-            echo "There has been some errors in overview checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed2 == "true" ]]; then
-            echo "There has been some errors in getting started checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed3 == "true" ]]; then
-            echo "There has been some errors in tutorials checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed4 == "true" ]]; then
-            echo "There has been some errors in reference checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed5 == "true" ]]; then
-            echo "There has been some errors in support checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed6 == "true" ]]; then
-            echo "There has been some errors in changelogs checks, please check the step."
-            failed=true
-          fi
-          if [[ $failed == "true" ]]; then
-            exit 1
-          fi
+          import sys
+          import os
+
+          found_error = False
+          sections = os.getenv('SECTIONS').split()
+
+          for i, section in enumerate(sections):
+            failed = os.getenv(f"failed{i}")
+            if failed == "true":
+              print(f"Found link errors in the {section} section. Please download the report artifact and fix.")
+              found_error = True
+
+          if found_error:
+            sys.exit(1)

.github/workflows/check-update-crd-reference.yaml

@@ -0,0 +1,20 @@
+# Validates the configuration for the CRD reference update script
+# in scripts/update-crd-reference
+
+name: check-update-crd-reference
+
+on:
+  push:
+    paths:
+      - scripts/update-crd-reference/*
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Validate configuration
+        run: |
+          make update-crd-reference

.github/workflows/create-highlights.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           persist-credentials: false
 
@@ -25,7 +25,7 @@ jobs:
         run: make collect-changelog-entries
 
       - name: Create or update highlight pull request
-        uses: gr2m/create-or-update-pull-request-action@v1.9.4
+        uses: gr2m/create-or-update-pull-request-action@b65137ca591da0b9f43bad7b24df13050ea45d1b # v1.10.1
         env:
           GITHUB_TOKEN: ${{ secrets.TOKEN }}
         with:
@@ -38,6 +38,6 @@ jobs:
             This PR has been created automatically by the 'Create highlight PR' Github workflow
             to publish the weekly highlights.
 
-            This action is triggered every Thrusday morning to collect all the highlights from the selected apps in giantswarm/github repository. The highlights are collected from the changelog entries from .github repository apps.
+            This action is triggered every Thursday morning to collect all the highlights from the selected apps in giantswarm/github repository. The highlights are collected from the changelog entries from .github repository apps.
 
             Please review the changes, group the entries for each app making sure it is digestible for the customers and highlight the breaking changes in the top.

.github/workflows/generate-review-issues.yaml

@@ -1,27 +1,27 @@
 name: Generate review Issues weekly
 on:
   schedule:
-    # At 0:00 on Sundays
-    - cron:  '0 0 * * 0' 
-
+    # At 0:05 on Sundays
+    - cron:  '5 0 * * 0'
 
 jobs:
   front-matter:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Install dependencies
         run: pip3 install click colored PyYAML
 
       - name: Validate front matter and last review date
-        run: |
-          echo "ISSUES=$(python3 scripts/validate-front-matter/script.py --validation last-reviewed --output json)" >> $GITHUB_ENV
-      
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN }}
+        run: make validate-last-reviewed
+
       - name: Generate issues of out of date docs
-        uses: giantswarm/[email protected]
-        with: 
+        uses: giantswarm/open-issue@7774937e31b23a52257a34462a753b0a28a4d1f1 # 0.3.0
+        with:
           token: ${{ secrets.ISSUE_AUTOMATION }}
           org: giantswarm
           repo: giantswarm

.github/workflows/merge-autogenerated-content.yml

@@ -16,35 +16,35 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           ref: "automatic-update-of-generated-content"
           fetch-depth: 0
 
       - name: Update self-generated content branch with main branch changes
-        uses: prompt/actions-merge-branch@v2
+        uses: prompt/actions-merge-branch@701d2a3e181424b84ebb58c95531d1d64fc3eccc # v2
         with:
           from: "origin/main"
 
       - name: Find Pull Request
-        uses: juliangruber/find-pull-request-action@v1
+        uses: juliangruber/find-pull-request-action@48b6133aa6c826f267ebd33aa2d29470f9d9e7d0 # v1.9.0
         id: find-pull-request
         with:
           branch: automatic-update-of-generated-content
 
       - name: Approve Pull Request
-        uses: juliangruber/approve-pull-request-action@v2
+        uses: juliangruber/approve-pull-request-action@b71c44ff142895ba07fad34389f1938a4e8ee7b0 # v2.0.6
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           number: ${{ steps.find-pull-request.outputs.number }}
 
       - name: GitHub Checks
-        uses: poseidon/wait-for-status-checks@v0.3.0
+        uses: poseidon/wait-for-status-checks@899c768d191b56eef585c18f8558da19e1f3e707 # v0.6.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Merge Pull Request
-        uses: juliangruber/merge-pull-request-action@v1
+        uses: juliangruber/merge-pull-request-action@9234b8714dda9a08f3d1df5b2a6a3abd7b695353 # v1.3.1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           number: ${{ steps.find-pull-request.outputs.number }}

.github/workflows/on-merge-create-release.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - name: Create Release
         id: create_release
-        uses: zendesk/action-create-release@v1
+        uses: zendesk/action-create-release@d690a6dcc904617a6ef45f845114e6e3d9f1b0af # v1
         with:
           tag_schema: semantic
         env:

.github/workflows/update-changes.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           persist-credentials: false
 
@@ -34,11 +34,12 @@ jobs:
       - name: Update CRD pages
         run: make update-crd-reference
 
-      - name: Update website header and footer
-        run: make update-website-content
+      # Disabled in Dec 2024 as it's not working afte rthe website update. (Marian)
+      #- name: Update website header and footer
+      #  run: make update-website-content
 
       - name: Create or update pull request
-        uses: gr2m/create-or-update-pull-request-action@v1.9.4
+        uses: gr2m/create-or-update-pull-request-action@b65137ca591da0b9f43bad7b24df13050ea45d1b # v1.10.1
         env:
           GITHUB_TOKEN: ${{ secrets.TOKEN }}
         with:

.github/workflows/validate-prose.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Execute Vale
         run: |