From 6fa64f828c38d665ceb382afad1d257ad87bc063 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Thu, 5 Feb 2026 08:53:33 +0100 Subject: [PATCH 1/2] Add docs-builder/setup action --- docs-builder/setup/README.md | 28 ++++++++++++++++++++ docs-builder/setup/action.yml | 49 +++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+) create mode 100755 docs-builder/setup/README.md create mode 100644 docs-builder/setup/action.yml diff --git a/docs-builder/setup/README.md b/docs-builder/setup/README.md new file mode 100755 index 0000000..2d08116 --- /dev/null +++ b/docs-builder/setup/README.md @@ -0,0 +1,28 @@ + +# docs-builder/setup + +Set up elastic/docs-builder CLI for use in actions + + +## Inputs + +| Name | Description | Required | Default | +|----------------|---------------------|----------|-----------------------| +| `version` | docs-builer version | `false` | `latest` | +| `github-token` | GitHub token | `true` | `${{ github.token }}` | + + +## Outputs + +| Name | Description | +|------|-------------| + + +## Usage + +```yaml +on: push +steps: + - uses: your/action@v1 +``` + diff --git a/docs-builder/setup/action.yml b/docs-builder/setup/action.yml new file mode 100644 index 0000000..70a4806 --- /dev/null +++ b/docs-builder/setup/action.yml @@ -0,0 +1,49 @@ +name: docs-builder/setup +description: 'Set up elastic/docs-builder CLI for use in actions' + +inputs: + version: + description: 'docs-builer version' + type: string + required: false + default: 'latest' + github-token: + description: 'GitHub token' + type: string + required: false + default: '${{ github.token }}' + +runs: + using: composite + + steps: + - name: Acquire docs-builder binary + shell: bash + run: | + echo "::group::Acquire docs-builder binary" + + if [[ "${DOCS_BUILDER_VERSION}" == "edge" ]]; then + docker cp $(docker create --name tc ghcr.io/elastic/docs-builder:edge):/app/docs-builder . && docker rm tc + exit 0; + fi + + if [[ "${DOCS_BUILDER_VERSION}" == "latest" ]]; then + DOCS_BUILDER_VERSION="" # empty string to get the latest version + fi + + gh release download "${DOCS_BUILDER_VERSION}" --pattern 'docs-builder-linux-x64.zip' --repo elastic/docs-builder + gh attestation verify ./docs-builder-linux-x64.zip -R elastic/docs-builder + unzip -p ./docs-builder-linux-x64.zip docs-builder > docs-builder + + echo "::endgroup::" + + env: + DOCS_BUILDER_VERSION: '${{ inputs.version }}' + GH_TOKEN: '${{ inputs.github-token }}' + + - name: Add docs-builder to /usr/local/bin + shell: bash + run: | + cp docs-builder /usr/local/bin/docs-builder + chmod +x /usr/local/bin/docs-builder + echo "::notice title=Builder version::$(docs-builder --version)" From ca38a48ad1bae6f8f5d321a1bf542648cd544162 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Thu, 5 Feb 2026 08:56:14 +0100 Subject: [PATCH 2/2] Fix usage example --- docs-builder/setup/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-builder/setup/README.md b/docs-builder/setup/README.md index 2d08116..a11e458 100755 --- a/docs-builder/setup/README.md +++ b/docs-builder/setup/README.md @@ -21,8 +21,8 @@ Set up elastic/docs-builder CLI for use in actions ## Usage ```yaml -on: push steps: - - uses: your/action@v1 + - uses: elastic/docs-actions/docs-builder/setup + - run: docs-builder --version ```