docgen.yml

name: Regenerate stdlib reference

# Regenerates the auto-documentation under _doc/stdlib/ref/ from the WurstStdlib2 hotdoc and
# opens a PR with the result. Runs on demand, weekly, or when WurstStdlib2 dispatches an event.
on:
  workflow_dispatch:
  schedule:
    - cron: "0 6 * * 1" # Mondays 06:00 UTC
  repository_dispatch:
    types: [stdlib-updated]

permissions:
  contents: write
  pull-requests: write

concurrency:
  group: stdlib-docgen
  cancel-in-progress: true

jobs:
  docgen:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout website
        uses: actions/checkout@v4

      - name: Checkout WurstStdlib2
        uses: actions/checkout@v4
        with:
          repository: wurstscript/WurstStdlib2
          ref: master
          path: _stdlib

      - name: Set up Deno
        uses: denoland/setup-deno@v2
        with:
          deno-version: v2.x

      - name: Generate reference
        working-directory: tools/docgen
        run: deno task gen --src "$GITHUB_WORKSPACE/_stdlib/wurst" --out "$GITHUB_WORKSPACE"

      - name: Open pull request
        uses: peter-evans/create-pull-request@v6
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: auto/stdlib-docgen
          delete-branch: true
          base: master
          title: "docs(stdlib): regenerate API reference"
          commit-message: "docs(stdlib): regenerate API reference"
          body: |
            Automated regeneration of the stdlib API reference from the latest
            [WurstStdlib2](https://github.com/wurstscript/WurstStdlib2) hotdoc.

            Generated by `.github/workflows/docgen.yml` (`tools/docgen`).
          add-paths: |
            _doc/stdlib/ref/**
            _data/stdlib_index.json