docs.yml

# Builds the docs/ Antora component as a site of its own (docs/antora-playbook.yml) and attaches it
# as the docs-site artifact: the rendered preview of a pull request (docs.arcadedb.com/arcadedb-python
# publishes main daily, ArcadeData/arcadedb-docs#505), and this job is the
# check a docs-only pull request gets: the test workflows ignore docs/** and *.adoc.
name: Docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
  pull_request:
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read

jobs:
  build:
    name: Build docs site
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: "24"

      - name: Build with Antora
        # Same version as docs.arcadedb.com (@antora/cli and @antora/site-generator ^3.2.1 in
        # ArcadeData/arcadedb-docs). The playbook fails the build on any warning.
        run: npx --yes -p @antora/cli@3.2.1 -p @antora/site-generator@3.2.1 antora docs/antora-playbook.yml

      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: docs-site
          path: docs/build/site
          retention-days: 14
          if-no-files-found: error