Merge pull request #16042 from crazy-max/validate-upstream

ci: validate upstream reusable workflow

.github/workflows/validate-upstream.yml

@@ -0,0 +1,87 @@
+# reusable workflow to validate docs from upstream repository for which pages are remotely fetched
+# - repo: repository to handle from fetch-remote in _config.yml (e.g., https://github.com/docker/buildx)
+# - data-files-id: id of the artifact (using actions/upload-artifact) containing the YAML data files to validate (optional)
+# - data-files-folder: folder in _data containing the files to download and copy to (e.g., buildx)
+name: validate-upstream
+
+on:
+  workflow_call:
+    inputs:
+      repo:
+        required: true
+        type: string
+      data-files-id:
+        required: false
+        type: string
+      data-files-folder:
+        required: false
+        type: string
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+        with:
+          repository: docker/docs
+      -
+        name: Install js-yaml
+        run: npm install js-yaml
+      -
+        name: Set correct ref to fetch remote resources
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const fs = require('fs');
+            const yaml = require('js-yaml');
+
+            const configFile = '_config.yml'
+            const config = yaml.load(fs.readFileSync(configFile, 'utf8'));
+            for (const remote of config['fetch-remote']) {
+              if (remote['repo'] != '${{ inputs.repo }}') {
+                continue;
+              }
+              if ("${{ github.event_name }}" == "pull_request") {
+                remote['repo'] = "${{ github.event.pull_request.head.repo.html_url }}";
+                remote['ref'] = "${{ github.event.pull_request.head.ref }}"
+              } else {
+                remote['ref'] = "${{ github.ref }}";
+              }
+            }
+
+            try {
+              fs.writeFileSync(configFile, yaml.dump(config), 'utf8')
+            } catch (err) {
+              console.error(err.message)
+              process.exit(1)
+            }
+      -
+        name: Prepare
+        run: |
+          # print docs jekyll config updated in previous step
+          yq _config.yml
+          # cleanup js-yaml module and data files
+          rm -rf ./node_modules
+          if [ -n "./_data/${{ inputs.data-files-folder }}" ]; then
+            rm -rf ./_data/${{ inputs.data-files-folder }}/*
+          fi
+      -
+        name: Download data files
+        uses: actions/download-artifact@v3
+        if: ${{ inputs.data-files-id != '' && inputs.data-files-dest != '' }}
+        with:
+          name: ${{ inputs.data-files-id }}
+          path: ./_data/${{ inputs.data-files-dest }}
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Validate
+        uses: docker/bake-action@v2
+        with:
+          targets: validate
+          set: |
+            *.cache-from=type=gha,scope=docs-upstream
+            *.cache-to=type=gha,scope=docs-upstream,mode=max