Skip to content

Add agentic workflow for documentation consistency#45778

Merged
laiapat merged 6 commits into
Azure:mainfrom
laiapat:agentic-workflow
Apr 27, 2026
Merged

Add agentic workflow for documentation consistency#45778
laiapat merged 6 commits into
Azure:mainfrom
laiapat:agentic-workflow

Conversation

@laiapat

@laiapat laiapat commented Mar 18, 2026

Copy link
Copy Markdown
Member

Description

See laiapat#3 for implementation in my fork; tracking issue #45674.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@laiapat laiapat requested review from a team, benbp, scbedd and weshaggard as code owners March 18, 2026 21:41
Copilot AI review requested due to automatic review settings March 18, 2026 21:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .github/workflows/doc-consistency-check.lock.yml
Comment thread .github/workflows/doc-consistency-check.lock.yml
Comment thread .gitattributes Outdated
Comment thread .github/workflows/doc-consistency-check.lock.yml
Comment thread .vscode/mcp.json
Comment thread .github/workflows/copilot-setup-steps.yml Outdated
Comment thread .github/workflows/doc-consistency-check.md
Comment thread .github/workflows/doc-consistency-check.lock.yml
@laiapat laiapat linked an issue Apr 8, 2026 that may be closed by this pull request
laiapat and others added 3 commits April 9, 2026 11:59
@laiapat laiapat force-pushed the agentic-workflow branch from 1e3c0c7 to 5555e54 Compare April 9, 2026 19:06
Comment thread .gitattributes Outdated
@laiapat laiapat requested a review from benbp April 9, 2026 22:45
Comment thread .vscode/mcp.json
@laiapat laiapat requested a review from benbp April 15, 2026 00:48
@laiapat laiapat merged commit 3bf5773 into Azure:main Apr 27, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create EngSys documentation consistency workflow

3 participants