deploy-docs.yml

# Example caller workflow for the Spring Cloud docs build.
#
# Copy this file to the `docs-build` branch of your project as
# .github/workflows/deploy-docs.yml. The same file works unchanged in both OSS
# and commercial repositories - the reusable workflow detects which one it is
# from the repository name and picks the runner and publish steps accordingly.
#
# This replaces the hand-maintained job that used to live on each `docs-build`
# branch. Nothing below should need to be customized per project.
#
# Note: this is the workflow that *builds* the docs. It is dispatched by the
# separate `deploy-docs.yml` that lives on each source branch (main, 4.3.x, ...)
# and is not covered by this example.

name: Deploy Docs
run-name: ${{ format('{0} ({1})', github.workflow, github.event.inputs.build-refname || 'all') }}

on:
  workflow_dispatch:
    inputs:
      build-refname:
        description: Enter git refname to build (e.g., 4.3.x).
        required: false
  push:
    branches: docs-build

permissions: read-all

jobs:
  deploy-docs:
    uses: spring-cloud/spring-cloud-github-actions/.github/workflows/deploy-docs.yml@main
    with:
      build_refname: ${{ github.event.inputs.build-refname }}
      # Optional overrides - the defaults are correct for every current project:
      # java_version: '17'
      # build_command: './mvnw --no-transfer-progress -B antora -Pdocs'
      # runs_on: 'ubuntu-latest'
      # context_root: 'spring-cloud-<project>'
    secrets: inherit