agents-api/.github/workflows/docs-agent.yml at main · Automattic/agents-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
name: Docs Agent

on:
  workflow_dispatch:
    inputs:
      prompt:
        description: Optional instruction appended to the technical documentation maintenance task.
        required: false
        default: Generate or update Agents API developer documentation from repository source. Open a documentation pull request only when changes are needed.

permissions:
  contents: write
  pull-requests: write
  issues: write

concurrency:
  group: docs-agent-${{ github.repository }}
  cancel-in-progress: false

jobs:
  docs-agent:
    name: Maintain Technical Documentation
    uses: Automattic/docs-agent/.github/workflows/maintain-docs.yml@7b67d341eea16b75b8e055507d36a8d8e69a1fe3
    with:
      audience: technical
      run_kind: maintenance
      base_ref: main
      docs_branch: docs-agent/agents-api-docs-upkeep-v2
      writable_paths: README.md,docs/**
      source_delta: |
        [
          {
            "id": "workflow-run-awaiter",
            "source_refs": [
              "https://github.com/Automattic/agents-api/pull/422",
              "src/Workflows/class-wp-agent-workflow-run-awaiter.php",
              "tests/workflow-run-awaiter-smoke.php"
            ],
            "requires_documentation_change": false
          }
        ]
      verification_commands: |
        [
          "composer install --no-interaction --prefer-dist --no-progress",
          "composer test",
          "php tests/no-product-imports-smoke.php"
        ]
      drift_checks: |
        [
          "git diff --check"
        ]
      prompt: |
        ${{ inputs.prompt }}

        Target repository: Automattic/agents-api
        Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

        Maintain source-grounded developer documentation for the public, product-neutral Agents API substrate. Cover developer contracts, setup, tests, and contributor workflows using repository source as evidence.
    secrets:
      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
      EXTERNAL_PACKAGE_SOURCE_POLICY: ${{ secrets.EXTERNAL_PACKAGE_SOURCE_POLICY }}