generate_documentation.yml

name: Generate Documentation
on:
  workflow_dispatch:
  push:
    branches: [main]
    paths:
      - 'rdf/processed/shapes.ttl'
  pull_request:
    branches: [main]
    paths:
      - 'rdf/processed/shapes.ttl'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: write

env:
  SHACL_PLAY_VERSION: "0.12.0"

jobs:
  run-pipeline:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Set up uv
        uses: astral-sh/setup-uv@v5
        with:
          python-version: "3.12"
          enable-caching: true

      - name: Install system dependencies
        run: sudo apt-get install -y libssh2-1-dev graphviz

      - name: Install dependencies
        run: uv sync

      - name: Restore SHACL-Play JAR cache
        id: cache-jar
        uses: actions/cache/restore@v4
        with:
          path: service/shacl_play
          key: shacl-play-jar-${{ env.SHACL_PLAY_VERSION }}

      - name: Run documentation script
        run: |
          uv run python service/shacl_docgen.py --diagram

      - name: Save SHACL-Play JAR cache
        if: steps.cache-jar.outputs.cache-hit != 'true'
        uses: actions/cache/save@v4
        with:
          path: service/shacl_play
          key: shacl-play-jar-${{ env.SHACL_PLAY_VERSION }}

      - name: Commit and push changes
        if: github.event_name != 'pull_request'
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add .
          git diff --cached --quiet || git commit -m "Update documentation [skip ci]"
          git push origin HEAD:${{ github.ref_name }}