cc @elastic/observablt-ci
Recent code changes introduced documentation drift in the Docs client-template permission guidance.
Changes Requiring Documentation Updates
1. Top-level permission guidance is outdated
Commit(s): 2e21976951efa974a5f9302ebcc423a5ad8cbf6a
What changed: Added top-level issues: read to Docs client templates:
.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-ai-menu.yml (permissions block)
.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu.yml (permissions block)
.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.yml (permissions block)
Documentation impact: docs/workflows/docs-aw-client-template.md still says top-level permissions on every client template are only contents: read (docs/workflows/docs-aw-client-template.md lines 40-43).
2. Collect-template permission matrix is outdated
Commit(s): 625a286be2a307a96caac2493f0e003c243357c8
What changed: Added job-level issues: read to collect workflow template:
.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.yml (jobs.collect.permissions)
Documentation impact: Permission matrix row for trigger-docs-aw-pr-ai-menu-collect.yml omits issues: read (docs/workflows/docs-aw-client-template.md line 51).
Suggested Actions
What is this? | From workflow: Observability Agentic Workflow — Autodoc
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
cc
@elastic/observablt-ciRecent code changes introduced documentation drift in the Docs client-template permission guidance.
Changes Requiring Documentation Updates
1. Top-level permission guidance is outdated
Commit(s):
2e21976951efa974a5f9302ebcc423a5ad8cbf6aWhat changed: Added top-level
issues: readto Docs client templates:.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-ai-menu.yml(permissions block).github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu.yml(permissions block).github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.yml(permissions block)Documentation impact:
docs/workflows/docs-aw-client-template.mdstill says top-level permissions on every client template are onlycontents: read(docs/workflows/docs-aw-client-template.mdlines 40-43).2. Collect-template permission matrix is outdated
Commit(s):
625a286be2a307a96caac2493f0e003c243357c8What changed: Added job-level
issues: readto collect workflow template:.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw-pr-ai-menu-collect.yml(jobs.collect.permissions)Documentation impact: Permission matrix row for
trigger-docs-aw-pr-ai-menu-collect.ymlomitsissues: read(docs/workflows/docs-aw-client-template.mdline 51).Suggested Actions
docs/workflows/docs-aw-client-template.mdtop-level permission section to list bothcontents: readandissues: readfor current Docs client templates.trigger-docs-aw-pr-ai-menu-collect.ymlto includeissues: readinrun-awjob permissions.issues: readis required in these templates (to prevent future permission drift).What is this? | From workflow: Observability Agentic Workflow — Autodoc
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.