Merge branch 'main' into dependabot/github_actions/dot-github/workflows/actions/checkout-5

Author: Mpdreamz

.github/updatecli/updatecli.d/versions.yml

@@ -25,20 +25,14 @@ actions:
       title: '[Automation] Bump product version numbers'
 
 sources:
-  # TODO Automate only for patch releases
-  # latest-stack-version:
-  #   name: Get latest stack version
-  #   kind: githubrelease
-  #   transformers:
-  #     - trimprefix: v
-  #   spec:
-  #     owner: elastic
-  #     repository: elasticsearch
-  #     token: '{{ requiredEnv "GITHUB_TOKEN" }}'
-  #     username: '{{ requiredEnv "GITHUB_ACTOR" }}'
-  #     versionfilter:
-  #       kind: regex
-  #       pattern: "v9.(\\d*).(\\d*)$"
+  latest-stack-version:
+    name: Get latest stack version
+    kind: json
+    spec:
+      files:
+        - https://artifacts.elastic.co/releases/stack.json
+      engine: dasel/v2
+      key: "releases.last().version"
 
   latest-edot-android-version:
     name: Get latest release version for the apm-agent-android
@@ -292,15 +286,15 @@ sources:
         pattern: "^@elastic/apm-rum@(\\d*).(\\d*).(\\d*)$"
 
 targets:
-  # update-docs-docset-stack:
-  #   name: 'Update config/versions.yml stack {{ source "latest-stack-version" }}'
-  #   scmid: githubConfig
-  #   sourceid: latest-stack-version
-  #   kind: file
-  #   spec:
-  #     file: config/versions.yml
-  #     matchpattern: '(stack: &stack\s+base: [\d\.]+\s+current:)\s+(.+)'
-  #     replacepattern: '$1 {{ source "latest-stack-version" }}'
+  update-docs-docset-stack:
+    name: 'Update config/versions.yml stack {{ source "latest-stack-version" }}'
+    scmid: githubConfig
+    sourceid: latest-stack-version
+    kind: file
+    spec:
+      file: config/versions.yml
+      matchpattern: '(stack: &stack\s+base: [\d\.]+\s+current:)\s+(.+)'
+      replacepattern: '$1 {{ source "latest-stack-version" }}'
 
   update-docs-docset-android:
     name: 'Update config/versions.yml edot-android {{ source "latest-edot-android-version" }}'

.github/workflows/prerelease.yml

@@ -35,7 +35,7 @@ jobs:
         with:
           prefix: '${{ steps.repo-basename.outputs.value }}'
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3.0.1
+        uses: actions/upload-pages-artifact@v4.0.0
         with:
           path: .artifacts/docs/html
 

.github/workflows/preview-build.yml

@@ -53,6 +53,11 @@ on:
         type: boolean
         default: false
         required: false
+      enable-cumulative-comment:
+        description: 'Enable info comment'
+        type: boolean
+        default: false
+        required: false
 
 permissions:
   contents: read
@@ -463,6 +468,7 @@ jobs:
           ALL_CHANGED_FILES: ${{ needs.check.outputs.all_changed_files }}
           PATH_PREFIX: ${{ needs.build.outputs.path_prefix }}
         with:
+          # language=javascript
           script: |
             const title = '## 🔍 Preview links for changed docs'
             const changedMdFiles = process.env.ALL_CHANGED_FILES
@@ -530,3 +536,58 @@ jobs:
                 body:body.join('\n'),
               });
             }
+      - name: Comment on docs changes about versioning requirements
+        if: inputs.enable-cumulative-comment == 'true'
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          # language=javascript
+          script: |
+            const pr = context.payload.pull_request;
+            const prNum = pr.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            
+             
+            const { data: comments } = await github.rest.issues.listComments({
+              owner, repo, issue_number: prNum
+            });
+            
+            const title = '## ℹ️ Important: Docs version tagging';
+            
+            const existingComment = comments.find(c =>
+              c.user.type === 'Bot' &&
+              c.body.startsWith(title)
+            );
+            
+            if (existingComment) return;
+            
+            const body = `${title}
+
+            👋 Thanks for updating the docs! Just a friendly reminder that our docs are now **cumulative**. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.
+            
+            We use [applies_to tags](https://elastic.github.io/docs-builder/syntax/applies) to mark version-specific features and changes.
+        
+            <details>
+            <summary>Expand for a quick overview</summary>
+        
+            ### When to use applies_to tags:
+            ✅ At the page level to indicate which products/deployments the content applies to (mandatory)
+            ✅ When features change state (e.g. preview, ga) in a specific version
+            ✅ When availability differs across deployments and environments
+        
+            ### What NOT to do:
+            ❌ Don't remove or replace information that applies to an older version
+            ❌ Don't add new information that applies to a specific version without an applies_to tag
+            ❌ Don't forget that applies_to tags can be used at the page, section, and inline level
+            </details>
+        
+            ### 🤔 Need help?
+            - Check out the [cumulative docs guidelines](https://elastic.github.io/docs-builder/contribute/cumulative-docs/)
+            - Reach out in the [#docs](https://elastic.slack.com/archives/C0JF80CJZ) Slack channel`;
+              
+            await github.rest.issues.createComment({
+              owner, repo,
+              issue_number: prNum,
+              body
+            });

.github/workflows/updatecli.yml

@@ -35,6 +35,7 @@ jobs:
       - uses: elastic/oblt-actions/updatecli/run@v1
         with:
           command: apply --config .github/updatecli/updatecli.d/versions.yml --values .github/updatecli/values.d/scm.yml
+          version-file: .updatecli-version
         env:
           GITHUB_TOKEN: ${{ steps.get_token.outputs.token }}
 

.updatecli-version

@@ -0,0 +1 @@
+v0.105.1

CONTRIBUTING.MD

@@ -0,0 +1,74 @@
+# Contributing
+
+## Prerequisites
+
+- [.NET 9.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
+- [Node.js 22.13.1 (LTS)](https://nodejs.org/en/blog/release/v22.13.1)
+  - [Aspire 9.4.1](https://learn.microsoft.com/en-us/dotnet/aspire/)
+	```bash
+	dotnet workload install aspire
+	```
+
+## Validate the fully assembled documentation
+
+```bash
+dotnet run --project aspire
+```
+
+Will spin up all our services and clone and build all the documentation sets. 
+
+```markdown
+dotnet run --project aspire -- --assume-cloned --skip-private-repositories
+```
+
+`--assume-cloned` will assume a documentation set set is already cloned if available locally.
+
+`--skip-private-repositories` will skip cloning private repositories. It will also inject our `docs-builder docs into the 
+navigation. This allows us to validate new features' effect on the assembly process.
+
+Our [Integration Tests](./tests-integration/Elastic.Assembler.IntegrationTests) use this exact command to validate the 
+assembler builds.
+
+## Continuously build all assets during development.
+
+```shell
+./build.sh watch
+```
+
+This will monitor code, cshtml template files & static files and reload the application
+if any changes.
+
+Web assets are reloaded through `parcel watch` and don't require a recompilation.
+
+Markdown files are refreshed automatically through livereload
+
+Code or layout changes will relaunch the server automatically
+
+# Release Process
+
+This section outlines the process for releasing a new version of this project.
+
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/) and its version is
+automatically determined by [release-drafter](https://github.com/release-drafter/release-drafter)
+based on the labels of the pull requests merged into the `main` branch.
+
+See the [release-drafter configuration](./.github/release-drafter.yml) for more details.
+
+## Creating a New Release
+
+To create a new release trigger the [release](https://github.com/elastic/docs-builder/actions/workflows/release.yml) workflow on the `main` branch.
+
+Every time a pull request is merged into the `main` branch, release-drafter will
+create a draft release or update the existing draft release in the [Releases](https://github.com/elastic/docs-builder/releases) page.
+
+To create a new release you need to publish the existing draft release created by release-drafter.
+
+> [!IMPORTANT]
+> Make sure the [release-drafter workflow](https://github.com/elastic/docs-builder/actions/workflows/release-drafter.yml) is finished before publishing the release.
+
+> [!NOTE]
+> When a release is published, the [create-major-tag workflow](./.github/workflows/create-major-tag.yml)
+> will force push a new major tag in the format `vX` where `X` is the major version of the release.
+> For example, if the release is `1.2.3` was published, the workflow will force push a new tag `v1` on the same commit.