generate-api-reference.yml

# SPDX-License-Identifier: Apache-2.0

name: Generate API Reference

on:
  workflow_call:
    inputs:
      actions-repo:
        type: string
        default: 'nubificus/vaccel'
      actions-ref:
        type: string
        default: 'main'
      deploy:
        type: boolean
        default: false
      target-repo-owner:
        type: string
        default: 'nubificus'
      target-repo-name:
        type: string
        default: 'vaccel-docs'
      target-workflow:
        type: string
        default: 'dispatch-update-external-repo.yml'
    secrets:
      VACCEL_BOT_PRIVATE_KEY:
        required: true

permissions: read-all

jobs:
  generate-reference:
    name: Generate API Reference
    runs-on: base-dind-2204-amd64
    steps:
      - name: Parse repository names
        id: parse-repos
        env:
          ACTIONS_REPO: ${{ inputs.actions-repo }}
        run: |
          {
            echo "repo-name=$(basename "$GITHUB_REPOSITORY")"
            echo "actions-repo-name=$(basename "$ACTIONS_REPO")"
          } >> "$GITHUB_OUTPUT"
        shell: bash

      - name: Generate initialization vaccel-bot token
        id: generate-init-token
        uses: actions/create-github-app-token@v3
        with:
          client-id: ${{ vars.VACCEL_BOT_CLIENT_ID }}
          private-key: ${{ secrets.VACCEL_BOT_PRIVATE_KEY }}
          repositories: |
            ${{ steps.parse-repos.outputs.repo-name }}
            ${{ steps.parse-repos.outputs.actions-repo-name }}
          permission-contents: read

      - name: Checkout .github directory
        uses: actions/checkout@v6
        with:
          sparse-checkout: .github
          repository: ${{ inputs.actions-repo }}
          ref: ${{ inputs.actions-ref }}
          token: ${{ steps.generate-init-token.outputs.token }}

      - name: Initialize workspace
        id: initialize-workspace
        uses: ./.github/actions/initialize-workspace
        with:
          remote-actions-repo: ${{ inputs.actions-repo }}
          fetch-depth: 0
          submodules: 'false'
          token: ${{ steps.generate-init-token.outputs.token }}

      - name: Determine SHA and branch
        id: get-revision
        uses: ./.github/actions/get-revision-info

      - name: Generate trigger vaccel-bot token
        id: generate-trigger-token
        uses: actions/create-github-app-token@v3
        with:
          client-id: ${{ vars.VACCEL_BOT_CLIENT_ID }}
          private-key: ${{ secrets.VACCEL_BOT_PRIVATE_KEY }}
          owner: ${{ inputs.target-repo-owner }}
          repositories: ${{ inputs.target-repo-name }}
          permission-contents: read
          permission-checks: read
          permission-actions: write

      - name: Create docs PR
        timeout-minutes: 30
        env:
          GH_TOKEN: ${{ steps.generate-trigger-token.outputs.token }}
          TARGET_WORKFLOW: ${{ inputs.target-workflow }}
          REPO: >-
            ${{ format('{0}/{1}',
              inputs.target-repo-owner, inputs.target-repo-name) }}
          TRIGGER_ID: ${{ github.run_id }}
          REF: ${{ steps.get-revision.outputs.sha }}
          BRANCH: ${{ steps.get-revision.outputs.branch }}
          DEPLOY: ${{ inputs.deploy }}
          WATCH_INTERVAL_SEC: 20
        run: |
          run_url=$(gh workflow run "$TARGET_WORKFLOW" \
            --repo "$REPO" \
            -f trigger-id="$TRIGGER_ID" \
            -f ref="$REF" \
            -f branch="$BRANCH" \
            -f repository="$GITHUB_REPOSITORY" \
            -f deploy="$DEPLOY")
          run_id="${run_url##*/}"

          echo "Triggered workflow run: ${run_url}"
          {
            echo "## Create docs PR summary"
            echo "- Triggered **${REPO}** run [#${run_id}](${run_url})"
          } >> "$GITHUB_STEP_SUMMARY"

          echo "Waiting for run to complete..."
          gh run watch "$run_id" \
            --repo "$REPO" \
            --interval "$WATCH_INTERVAL_SEC" \
            --compact \
            --exit-status

          echo "Run completed successfully"
          [[ "$DEPLOY" == 'true' ]] || exit 0

          run_log=$(gh run view "$run_id" --repo "$REPO" --log)
          read -r pr_number pr_operation pr_url < <(echo "$run_log" | awk '
            /Pull request number:/   { number = $NF }
            /Pull request operation:/ { operation = $NF }
            /Pull request URL:/      { url = $NF }
            END { print number, operation, url }
          ')

          if [[ -n "$pr_operation" ]]; then
            echo "${pr_operation^} PR: ${pr_url}"
            echo "- ${pr_operation^} PR [${REPO}#${pr_number}](${pr_url})" \
              >> "$GITHUB_STEP_SUMMARY"
          else
            echo "No PR was created or updated"
            echo "- No PR was created or updated" >> "$GITHUB_STEP_SUMMARY"
          fi
        shell: bash