Merge branch 'main' into remove-android-ios-agent-nav

Author: theletterf

.github/CODEOWNERS

@@ -1 +1,2 @@
-*   @elastic/docs-engineering
+* @elastic/docs-engineering
+/docs/ @elastic/docs

.github/actions/bootstrap/action.yml

@@ -35,6 +35,6 @@ runs:
     - uses: actions/setup-node@v4
       with:
         cache: npm
-        cache-dependency-path: src/Elastic.Markdown/package-lock.json
+        cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
         node-version-file: .nvmrc
 

.github/dependabot.yml

@@ -16,6 +16,20 @@ updates:
       interval: 'weekly'
       day: 'monday'
       time: '08:00'
+    groups:
+      eslint:
+        patterns:
+          - 'eslint'
+          - '@eslint/*'
+          - 'typescript-eslint'
+      eui:
+        patterns:
+          - '@elastic/eui*'
+      tailwindcss:
+        patterns:
+          - 'tailwindcss'
+          - '@tailwindcss/postcss'
+          - 'prettier-plugin-tailwindcss'
     labels:
       - chore
   - package-ecosystem: nuget

.github/workflows/pr.yml renamed to .github/workflows/ci.yml

@@ -1,6 +1,9 @@
-name: PR
+name: ci
 
 on:
+  push:
+    branches:
+      - main
   pull_request:
 
 permissions:
@@ -14,7 +17,7 @@ env:
   NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
 
 jobs:
-  validate-navigation:
+  validate-assembler:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -23,24 +26,27 @@ jobs:
         id: bootstrap
         uses: ./.github/actions/bootstrap
 
-      - name: Build
+      - name: Validate Navigation
         run: dotnet run --project src/tooling/docs-assembler -c release -- navigation validate
 
+      - name: Validate Content Sources
+        run: dotnet run --project src/tooling/docs-assembler -c release -- content-source validate
+
   build-lambda:
     uses: ./.github/workflows/build-link-index-updater-lambda.yml
 
   lint:
     runs-on: ubuntu-latest
     defaults: 
       run: 
-        working-directory: src/Elastic.Markdown
+        working-directory: src/Elastic.Documentation.Site
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-node@v4
         with:
           cache: npm
-          cache-dependency-path: src/Elastic.Markdown/package-lock.json
+          cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
           node-version-file: .nvmrc
 
       - name: Install dependencies

.github/workflows/preview-build.yml

@@ -1,7 +1,7 @@
 name: preview-build
 
 on:
-  pull_request_target:
+  pull_request:
     types:
       - opened
       - synchronize
@@ -10,6 +10,13 @@ on:
     branches:
       - main
       - master
+      # TODO remove these need to be added to individual repositories
+      - '\d+.\d+.\d+'
+      - '\d+.\d+'
+      - '\d+.x'
+    tags:
+      - 'v?\d+.\d+.\d+'
+      - 'v?\d+.\d+'
   workflow_call:
     inputs:
       strict:
@@ -31,19 +38,67 @@ on:
         type: string
         default: '**'
         required: false
+      path-pattern-ignore:
+        description: 'Path pattern to ignore files.'
+        type: string
+        default: ''
+        required: false
       free-disk-space:
         description: 'Free disk space before running the build'
         type: string
         default: 'false'
         required: false
+      disable-comments:
+        description: 'Disable comments'
+        type: boolean
+        default: false
+        required: false
 
 permissions:
   id-token: write
   deployments: write
   contents: read
-  pull-requests: read
+  pull-requests: write
 
 jobs:
+  match:
+    if: github.event.repository.fork == false # Skip running the job on the fork itself (It still runs on PRs on the upstream from forks)
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.event.pull_request.head.ref || github.ref }}
+      cancel-in-progress: ${{ startsWith(github.event_name, 'pull_request') }}
+    runs-on: ubuntu-latest
+    outputs:
+      content-source-match: ${{ steps.event-check.outputs.content-source-match != '' && steps.event-check.outputs.content-source-match || steps.match.outputs.content-source-match }}
+      content-source-next: ${{ steps.event-check.outputs.content-source-next != '' && steps.event-check.outputs.content-source-next || steps.match.outputs.content-source-next }}
+      content-source-current: ${{ steps.event-check.outputs.content-source-current != '' && steps.event-check.outputs.content-source-current || steps.match.outputs.content-source-current }}
+      content-source-speculative: ${{ steps.event-check.outputs.content-source-speculative != '' && steps.event-check.outputs.content-source-speculative || steps.match.outputs.content-source-speculative }}
+    steps:
+      - name: Not a push event
+        id: event-check
+        if: contains(fromJSON('["merge_group", "pull_request", "pull_request_target"]'), github.event_name)
+        # we always want to run for pull requests, but we do not want to indicate its either content source
+        run: |
+          echo "content-source-match=true" >> $GITHUB_OUTPUT
+          echo "content-source-next=false" >> $GITHUB_OUTPUT
+          echo "content-source-current=false" >> $GITHUB_OUTPUT
+          echo "content-source-speculative=false" >> $GITHUB_OUTPUT
+      - name: Match for push events
+        id: match
+        if: contains(fromJSON('["push"]'), github.event_name)
+        uses: elastic/docs-builder/actions/assembler-match@main
+        with:
+          ref_name: ${{ github.ref_name }}
+          repository: ${{ github.repository }}
+      - name: Debug
+        run: |
+          echo "Non sensitive data, echo'ing here temporarily to validate this job before connecting it further into the build job"
+          echo "content-source-match=${{ steps.event-check.outputs.content-source-match != '' && steps.event-check.outputs.content-source-match || steps.match.outputs.content-source-match }}"
+          echo "content-source-next=${{ steps.event-check.outputs.content-source-next != '' && steps.event-check.outputs.content-source-next || steps.match.outputs.content-source-next }}"
+          echo "content-source-current=${{ steps.event-check.outputs.content-source-current != '' && steps.event-check.outputs.content-source-current || steps.match.outputs.content-source-current }}"
+          echo "content-source-speculative=${{ steps.event-check.outputs.content-source-speculative != '' && steps.event-check.outputs.content-source-speculative || steps.match.outputs.content-source-speculative }}"
+          echo "ref=${{ github.ref_name }}"
+          echo "repo=${{ github.repository }}"
+
   build:
     if: github.event.repository.fork == false # Skip running the job on the fork itself (It still runs on PRs on the upstream from forks)
     concurrency:
@@ -52,30 +107,37 @@ jobs:
     runs-on: ubuntu-latest
     env:
       GITHUB_PR_REF_NAME: ${{ github.event.pull_request.head.ref }}
+      MATCH: ${{ needs.match.outputs.content-source-match }}
+    needs: [ match ]
     steps:
 
       - name: Checkout
-        if:  contains(fromJSON('["push", "merge_group", "workflow_dispatch"]'), github.event_name)
+        if:  env.MATCH == 'true' && (contains(fromJSON('["push", "merge_group", "workflow_dispatch"]'), github.event_name))
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha || github.ref }}
 
       - name: Get changed files
-        if: contains(fromJSON('["merge_group", "pull_request", "pull_request_target"]'), github.event_name)
+        if: env.MATCH == 'true' && (contains(fromJSON('["merge_group", "pull_request", "pull_request_target"]'), github.event_name))
         id: check-files
         uses: tj-actions/changed-files@2f7c5bfce28377bc069a65ba478de0a74aa0ca32 # v46.0.1
         with:
           files: ${{ inputs.path-pattern != '' && inputs.path-pattern || '**' }}
+          files_ignore: ${{ inputs.path-pattern-ignore != '' && inputs.path-pattern-ignore || '' }}
 
       - name: Checkout
-        if: startsWith(github.event_name, 'pull_request') && steps.check-files.outputs.any_modified == 'true'
+        if: env.MATCH == 'true' && (startsWith(github.event_name, 'pull_request') && steps.check-files.outputs.any_modified == 'true')
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha || github.ref }}
           persist-credentials: false
 
       - name: Create Deployment
-        if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) || (steps.check-files.outputs.any_modified == 'true' && startsWith(github.event_name, 'pull_request'))
+        if: |
+          env.MATCH == 'true' && 
+            (contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) 
+                || (steps.check-files.outputs.any_modified == 'true' && startsWith(github.event_name, 'pull_request'))
+            )
         uses: actions/github-script@v7
         id: deployment
         env:
@@ -108,7 +170,7 @@ jobs:
             return deployment.data.id
 
       - name: Generate env.PATH_PREFIX
-        if: steps.deployment.outputs.result
+        if: env.MATCH == 'true' && (steps.deployment.outputs.result)
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
           GITHUB_REF_NAME: ${{ github.ref_name }}
@@ -119,10 +181,6 @@ jobs:
               ;;
             "push" | "workflow_dispatch")
               echo "PATH_PREFIX=/${GITHUB_REPOSITORY}/tree/${GITHUB_REF_NAME}" >> $GITHUB_ENV
-              if [[ ! "${GITHUB_REF_NAME}" =~ ^(main|master|16\.x)$ ]]; then
-                echo "Unsupported ref name: '${GITHUB_REF_NAME}'";
-                exit 1;
-              fi
               ;;
             *)
               echo "Unsupported event: '${GITHUB_EVENT_NAME}'";
@@ -131,53 +189,150 @@ jobs:
           esac
 
       - name: Bootstrap Action Workspace
-        if: github.repository == 'elastic/docs-builder' && steps.deployment.outputs.result
+        if: env.MATCH == 'true' && (github.repository == 'elastic/docs-builder' && steps.deployment.outputs.result)
         uses: elastic/docs-builder/.github/actions/bootstrap@main
 
-      # we run our artifact directly please use the prebuild
+      # we run our artifact directly, please use the prebuild
       # elastic/docs-builder@main GitHub Action for all other repositories!
       - name: Build documentation
-        if: github.repository == 'elastic/docs-builder' && steps.deployment.outputs.result
+        if: env.MATCH == 'true' && (github.repository == 'elastic/docs-builder' && steps.deployment.outputs.result)
         run: |
           dotnet run --project src/tooling/docs-builder -- --strict --path-prefix "${PATH_PREFIX}"
 
       - name: Build documentation
-        if: github.repository != 'elastic/docs-builder' && (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group'))
+        if: | 
+          env.MATCH == 'true' && 
+            (github.repository != 'elastic/docs-builder' && 
+                (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group'))
+            )
         uses: elastic/docs-builder@main
         id: docs-build
         continue-on-error: ${{ fromJSON(inputs.continue-on-error != '' && inputs.continue-on-error || 'false') }}
         with:
           prefix: ${{ env.PATH_PREFIX }}
           strict: ${{ fromJSON(inputs.strict != '' && inputs.strict || 'true') }}
-          metadata-only: ${{ fromJSON(inputs.metadata-only != '' && inputs.metadata-only || 'true') }}
+          metadata-only: ${{ fromJSON(inputs.metadata-only != '' && inputs.metadata-only || 'false') }}
 
       - name: 'Validate inbound links'
-        if: ${{ !cancelled() && steps.docs-build.outputs.skip != 'true' && (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group')) }}
+        if: |
+          env.MATCH == 'true' && 
+          (!cancelled() && steps.docs-build.outputs.skip != 'true' 
+            && (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group'))
+          )
         uses: elastic/docs-builder/actions/validate-inbound-local@main
 
       - name: 'Validate local path prefixes against those claimed by global navigation.yml'
-        if: ${{ !cancelled() && steps.docs-build.outputs.skip != 'true' && (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group')) }}
+        if: |
+          env.MATCH == 'true' && 
+          (!cancelled() && steps.docs-build.outputs.skip != 'true' && 
+            (steps.deployment.outputs.result || (steps.check-files.outputs.any_modified == 'true' && github.event_name == 'merge_group'))
+          )
         uses: elastic/docs-builder/actions/validate-path-prefixes-local@main
 
       - uses: elastic/docs-builder/.github/actions/aws-auth@main
         if: ${{ !cancelled() && steps.docs-build.outputs.skip != 'true' && steps.deployment.outputs.result }}
 
       - name: Upload to S3
         id: s3-upload
-        if: ${{ !cancelled() && steps.docs-build.outputs.skip != 'true' && steps.deployment.outputs.result }}
+        if: |
+          env.MATCH == 'true' && 
+          (!cancelled() && steps.docs-build.outputs.skip != 'true' && steps.deployment.outputs.result)
         run: |
           aws s3 sync .artifacts/docs/html "s3://elastic-docs-v3-website-preview${PATH_PREFIX}" --delete --no-follow-symlinks
           aws cloudfront create-invalidation \
             --distribution-id EKT7LT5PM8RKS \
             --paths "${PATH_PREFIX}" "${PATH_PREFIX}/*"
+          
+      - name: Comment on PR
+        continue-on-error: true
+        if: startsWith(github.event_name, 'pull_request') && inputs.disable-comments != 'true' && env.MATCH == 'true' && steps.deployment.outputs.result && steps.check-files.outputs.all_changed_files
+        uses: actions/github-script@v7
+        env:
+          ALL_CHANGED_FILES: ${{ steps.check-files.outputs.all_changed_files }}
+        with:
+          script: |
+            const title = '## 🔍 Preview links for changed docs'
+            const changedMdFiles = process.env.ALL_CHANGED_FILES
+              .split(/\s+/)
+              .filter(i => i.endsWith('.md'))
+              .filter(i => !i.includes('/_snippets/'));
+            
+            if (changedMdFiles.length === 0) {
+              return;
+            }
+            
+            const toLink = (file) => {
+              const path = file
+                .replace('docs/', '')
+                .replace('/index.md', '')
+                .replace('.md', '');
+              return `[${file}](https://docs-v3-preview.elastic.dev${process.env.PATH_PREFIX}/${path})`;
+            }
+            
+            const links = changedMdFiles.map(toLink)
+            
+            const body = [
+              title,
+              ...links.slice(0, 10).map(i => `- ${i}`),
+            ]
+            
+            if (links.length > 10) {
+              body.push('<details>');
+              body.push('<summary>More links …</summary>');
+              body.push('');
+              for (const link of links.slice(10, 100)) {
+                body.push(`- ${link}`);
+              }
+              body.push('');
+              body.push('</details>');
+            }
+            
+            if (links.length > 100) {
+              body.push('');
+              body.push(`<sub>In total, ${links.length} files changed.</sub>`);
+            }
+            
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const issue_number = context.payload.pull_request.number;
+            
+            // Post or update a single bot comment
+            const { data: comments } = await github.rest.issues.listComments({
+              owner, repo, issue_number
+            });
+            const existing = comments.find(c =>
+              c.user.type === 'Bot' &&
+              c.body.startsWith(title)
+            );
+            if (existing) {
+              await github.rest.issues.updateComment({
+                owner, repo,
+                comment_id: existing.id,
+                body: body.join('\n'),
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner, repo,
+                issue_number,
+                body:body.join('\n'),
+              });
+            }
 
       - name: Update Link Index
-        if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master') && steps.s3-upload.outcome == 'success'
+        if: |
+          env.MATCH == 'true' && 
+          (contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) 
+            && (
+                needs.match.outputs.content-source-current == 'true' 
+                || needs.match.outputs.content-source-next == 'true'
+                || needs.match.outputs.content-source-speculative == 'true'
+            ) 
+            && steps.s3-upload.outcome == 'success')
         uses: elastic/docs-builder/actions/update-link-index@main
 
       - name: Update deployment status
         uses: actions/github-script@v7
-        if: always() && steps.deployment.outputs.result
+        if: env.MATCH == 'true' && (always() && steps.deployment.outputs.result)
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
           LANDING_PAGE_PATH: ${{ steps.docs-build.outputs.landing-page-path || env.PATH_PREFIX }}