- Notifications
You must be signed in to change notification settings - Fork1.1k
feat: add documentation check workflow for pull requests#20907
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
…ith create-task-action
9be8518 todee3fceComparegithub-actionsbot commentedNov 24, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
DevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededReason: Internal CI/CD workflow - No user-facing impact This PR adds a GitHub Actions workflow (
Since this is an internal development tool that doesn't affect Coder users, end-users, admins, or the public API/CLI, no documentation updates are needed. The workflow is self-contained in |
4da456c to36b76bdCompareDevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededReason: Internal CI/CD tooling only - no user-facing impact This PR adds an internal GitHub Actions workflow (
Why no docs needed:
The existing documentation about GitHub Actions in README.md (Setup Coder action, Template action) remains accurate and complete. This new workflow is purely for internal development process improvement. I'm a Bot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull request overview
This PR introduces a new GitHub Actions workflow for automated documentation checks on pull requests. The workflow triggers when thedoc-check label is added to a PR or via manual dispatch, and uses a Coder task to analyze PR changes and provide documentation recommendations.
Key changes:
- Adds a new workflow that integrates with create-task-action to analyze PRs for documentation needs
- Implements dual trigger modes: label-based (on PR labeled) and manual (workflow_dispatch)
- Uses bash scripting to extract PR context and build prompts for AI-based documentation analysis
💡Add Copilot custom instructions for smarter, more guided reviews.Learn how to get started.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…cify AI Agent usage
DevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededThis PR adds a GitHub Actions workflow (
The workflow enhances the existing contribution process without changing any user-visible functionality or requiring external contributors to understand its implementation details. This comment was generated by an AI Agent throughCoder Tasks |
DevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededReason: Internal changes only - No user-facing impact This PR adds a GitHub Actions workflow (
This is an internal development workflow that:
The existing contributing documentation in This comment was generated by an AI Agent throughCoder Tasks |
… to point to manifest.json which is less restrictive and updates with new changes
DevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededReason: Internal automation workflow - no user-facing impact Analysis:
This workflow is not user-facing and does not require documentation because:
If this workflow were to be made available for external contributors or required special setup, documentation could be added to This comment was generated by an AI Agent throughCoder Tasks |
DevelopmentCats commentedNov 24, 2025
📚 Documentation Check✨ No Changes NeededThis PR adds a new GitHub Actions workflow ( Reasoning:
The workflow integrates with Coder Tasks to analyze PRs and suggest documentation updates, but this is a contributor/maintainer workflow, not something end users need to know about or interact with. This comment was generated by an AI Agent throughCoder Tasks |
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
f08cb2f intomainUh oh!
There was an error while loading.Please reload this page.
matifali commentedNov 25, 2025
I think we should keep updating the single comment instead of making a new comment on each new commit |
Uh oh!
There was an error while loading.Please reload this page.
This pull request adds a new GitHub Actions workflow to automate documentation checks for pull requests. The workflow uses an AI-powered Coder Task to analyze PR changes, search relevant documentation, and comment with recommendations on whether documentation updates are needed.
New AI Documentation Check Workflow:
.github/workflows/doc-check.yamlto automate documentation review for PRs, triggered by thedoc-checklabel or manual dispatch.Workflow Features:
coder/create-task-actionto create a Coder Task that reviews the PR and posts documentation recommendations as a comment.