docs.yml

name: Docs

on:
  workflow_dispatch:
  push:
    branches: [main]
    paths:
      - "**/*.md"
      - "docs/**"
      - "!CHANGELOG.md"
      - "!CHANGELOG/**"

permissions:
  contents: read

concurrency:
  group: ${{ format('{0}-{1}-{2}', github.workflow, github.event_name, github.ref) }}
  cancel-in-progress: true

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"

jobs:
  docs:
    # Hourly CI owns scheduled docs validation, including its RunsOn route.
    if: github.event_name != 'push' || github.ref != 'refs/heads/main' || vars.OPENCLAW_CI_ON_PUSH == 'true'
    runs-on: ubuntu-24.04
    timeout-minutes: 20
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 1
          fetch-tags: false
          persist-credentials: false
          submodules: false

      - name: Setup Node environment
        uses: ./.github/actions/setup-node-env
        with:
          cache-mode: restore
          install-bun: "false"

      - name: Checkout ClawHub docs source
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          repository: openclaw/clawhub
          ref: main
          path: clawhub-source
          fetch-depth: 1
          persist-credentials: false

      - name: Check docs
        env:
          OPENCLAW_DOCS_SYNC_CLAWHUB_REPO: ${{ github.workspace }}/clawhub-source
        run: pnpm check:docs