clp-docs-generated-code-checks.yaml

name: "clp-docs-generated-code-checks"

on:
  pull_request:
  push:
  workflow_dispatch:

concurrency:
  group: "${{github.workflow}}-${{github.ref}}"
  # Cancel in-progress jobs for efficiency
  cancel-in-progress: true

jobs:
  check-generated:
    # Runs only on Ubuntu Jammy (22.04) since the Rust components are only built on this platform.
    runs-on: "ubuntu-22.04"
    steps:
      - uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd"  # v6.0.2
        with:
          submodules: "recursive"

      - uses: "./tools/yscope-dev-utils/exports/github/actions/install-go-task"
        with:
          version: "3.48.0"

      - name: "Generate OpenAPI docs"
        shell: "bash"
        run: "task codegen:openapi"

      - name: "Check if the generated code is the latest"
        shell: "bash"
        run: |-
          stale_files="$(git status --porcelain docs/src/_static/generated)"
          if [[ -n "${stale_files}" ]]; then
            echo >&2 "ERROR: The following generated files are out of date:"
            echo >&2 "${stale_files}"
            echo >&2 ""
            echo >&2 "Please run 'task codegen:openapi' locally and commit the updated files."
            git diff >&2 docs/src/_static/generated
            exit 1
          fi