build-with-wordpress/.github/workflows/developer-docs-agent.yml at 855e5ec8df9d1a8649933a50f0a3a61dfc6774fa · Automattic/build-with-wordpress · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
name: Build With WordPress Developer Docs Agent

on:
  workflow_dispatch:
    inputs:
      run_kind:
        description: Documentation run mode
        required: false
        default: maintenance
        type: choice
        options:
          - maintenance
          - bootstrap
  push:
    branches:
      - trunk

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

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

jobs:
  developer-docs-agent:
    name: Maintain Developer Docs
    uses: Automattic/docs-agent/.github/workflows/maintain-docs.yml@a39d9db230eb9e0b72ed84465f4d61bd8dda1bab
    with:
      audience: technical
      run_kind: ${{ github.event.inputs.run_kind || 'maintenance' }}
      require_pr: ${{ github.event_name == 'workflow_dispatch' }}
      base_ref: trunk
      docs_branch: docs-agent/build-with-wordpress-developer-docs
      writable_paths: README.md,docs/**,plugins/**/README.md
      bootstrap_contract: |
        {
          "required_paths": ["README.md", "docs/README.md"],
          "required_globs": [{"pattern": "docs/**/*.md", "min_count": 3}],
          "entry_points": [{"path": "README.md", "must_link_to": ["docs/README.md"]}]
        }
      source_delta: |
        [
          {
            "id": "figma-studio-handoff-diagnostics",
            "source_refs": [
              "https://github.com/Automattic/build-with-wordpress/pull/100",
              "plugins/figma-to-wordpress-studio/src/payload.ts",
              "plugins/figma-to-wordpress-studio/src/ui.ts",
              "plugins/figma-to-wordpress-studio/tests/generate-artifact.test.mjs"
            ],
            "requires_documentation_change": true
          }
        ]
      verification_commands: |
        [
          "pnpm install --frozen-lockfile",
          "pnpm build",
          "pnpm verify"
        ]
      validation_dependencies: npm install --global pnpm@10.8.1
      drift_checks: |
        [
          {
            "command": "git diff --exit-code -- . ':(top,exclude)README.md' ':(top,glob,exclude)docs/**' ':(top,glob,exclude)plugins/**/README.md'",
            "description": "Generated package outputs outside developer documentation are committed after build"
          }
        ]
      prompt: |
        Maintain developer-facing documentation for Build with WordPress.

        Manual dispatch defaults to the native technical documentation maintenance package; select bootstrap only to intentionally re-bootstrap the documentation. Push-triggered runs use the native technical documentation maintenance package and should make the smallest source-grounded documentation update needed for newly merged code or finish with no changes when documentation is current.

        Write repository documentation with `docs/README.md` as the index, focused topic pages under `docs/**`, and `plugins/**/README.md` only when a plugin package needs local developer-facing contract notes. Cover the repository purpose, package layout, generated plugin artifacts, build and verification commands, skill packaging, Studio integration points, and contributor workflows.

        Keep the developer documentation current with the native maintenance lanes in `.github/workflows/developer-docs-agent.yml` and `.github/workflows/skills-agent.yml`, including their purpose, writable boundaries, verification contract, and no-op behavior.
    secrets:
      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
      EXTERNAL_PACKAGE_SOURCE_POLICY: ${{ secrets.EXTERNAL_PACKAGE_SOURCE_POLICY }}