Add agentic workflow for documentation consistency#45778
Open
mccoyp wants to merge 2 commits intoAzure:mainfrom
Open
Add agentic workflow for documentation consistency#45778mccoyp wants to merge 2 commits intoAzure:mainfrom
mccoyp wants to merge 2 commits intoAzure:mainfrom
Conversation
mccoyp
requested review from
a team,
benbp,
scbedd and
weshaggard
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Agentic Workflows (gh-aw) based automation to periodically check repository documentation for inconsistencies and open a PR with fixes, along with local/dev setup support for running the workflow tooling.
Changes:
- Adds a doc consistency check gh-aw workflow source (
.md) and its compiled GitHub Actions workflow (.lock.yml). - Updates developer tooling/config to support running gh-aw (VS Code MCP config + Copilot setup workflow).
- Treats generated workflow lock files as generated in
.gitattributes.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
.vscode/mcp.json |
Adds an MCP server entry for gh-aw tooling. |
.github/workflows/doc-consistency-check.md |
Defines the gh-aw workflow prompt/instructions and frontmatter config. |
.github/workflows/doc-consistency-check.lock.yml |
Compiled GitHub Actions workflow that runs the agent and creates PRs via Safe Outputs. |
.github/workflows/copilot-setup-steps.yml |
Installs gh-aw CLI support in the Copilot setup workflow. |
.github/aw/actions-lock.json |
Adds an actions lock manifest for gh-aw-related actions. |
.github/agents/agentic-workflows.agent.md |
Adds an agent definition/dispatcher doc for gh-aw usage. |
.gitattributes |
Marks workflow lock files as generated and configures merge behavior. |
You can also share your feedback on Copilot code review. Take the survey.
| - agent | ||
| - safe_outputs | ||
| if: (always()) && (needs.agent.result != 'skipped') | ||
| runs-on: ubuntu-slim |
Comment on lines
+965
to
+967
| if: ((!cancelled()) && (needs.agent.result != 'skipped')) && (needs.agent.outputs.detection_success == 'true') | ||
| runs-on: ubuntu-slim | ||
| permissions: |
| #*.rtf diff=astextplain | ||
| #*.RTF diff=astextplain | ||
|
|
||
| .github/workflows/*.lock.yml linguist-generated=true merge=ours No newline at end of file |
| GH_AW_ALLOWED_DOMAINS: "api.business.githubcopilot.com,api.enterprise.githubcopilot.com,api.github.com,api.githubcopilot.com,api.individual.githubcopilot.com,api.snapcraft.io,archive.ubuntu.com,azure.archive.ubuntu.com,crl.geotrust.com,crl.globalsign.com,crl.identrust.com,crl.sectigo.com,crl.thawte.com,crl.usertrust.com,crl.verisign.com,crl3.digicert.com,crl4.digicert.com,crls.ssl.com,github.com,host.docker.internal,json-schema.org,json.schemastore.org,keyserver.ubuntu.com,ocsp.digicert.com,ocsp.geotrust.com,ocsp.globalsign.com,ocsp.identrust.com,ocsp.sectigo.com,ocsp.ssl.com,ocsp.thawte.com,ocsp.usertrust.com,ocsp.verisign.com,packagecloud.io,packages.cloud.google.com,packages.microsoft.com,ppa.launchpad.net,raw.githubusercontent.com,registry.npmjs.org,s.symcb.com,s.symcd.com,security.ubuntu.com,telemetry.enterprise.githubcopilot.com,ts-crl.ws.symantec.com,ts-ocsp.ws.symantec.com" | ||
| GITHUB_SERVER_URL: ${{ github.server_url }} | ||
| GITHUB_API_URL: ${{ github.api_url }} | ||
| GH_AW_SAFE_OUTPUTS_HANDLER_CONFIG: "{\"create_pull_request\":{\"labels\":[\"documentation\",\"automated\"],\"max\":1,\"max_patch_size\":1024,\"protected_files\":[\"package.json\",\"bun.lockb\",\"bunfig.toml\",\"deno.json\",\"deno.jsonc\",\"deno.lock\",\"global.json\",\"NuGet.Config\",\"Directory.Packages.props\",\"mix.exs\",\"mix.lock\",\"go.mod\",\"go.sum\",\"stack.yaml\",\"stack.yaml.lock\",\"pom.xml\",\"build.gradle\",\"build.gradle.kts\",\"settings.gradle\",\"settings.gradle.kts\",\"gradle.properties\",\"package-lock.json\",\"yarn.lock\",\"pnpm-lock.yaml\",\"npm-shrinkwrap.json\",\"requirements.txt\",\"Pipfile\",\"Pipfile.lock\",\"pyproject.toml\",\"setup.py\",\"setup.cfg\",\"Gemfile\",\"Gemfile.lock\",\"uv.lock\",\"AGENTS.md\"],\"protected_path_prefixes\":[\".github/\",\".agents/\"],\"title_prefix\":\"[docs] \"},\"missing_data\":{},\"missing_tool\":{}}" |
Comment on lines
+8
to
12
| "github-agentic-workflows": { | ||
| "command": "gh", | ||
| "args": ["aw", "mcp-server"], | ||
| "cwd": "${workspaceFolder}" | ||
| } |
Comment on lines
+39
to
+41
| - name: Checkout repository | ||
| uses: actions/checkout@v6 | ||
|
|
| tools: | ||
| github: | ||
| toolsets: [default] | ||
| edit: |
|
|
||
| jobs: | ||
| activation: | ||
| runs-on: ubuntu-slim |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
See mccoyp#3 for implementation in my fork; tracking issue #45674.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines