Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
DevelopmentCats merged 12 commits intomainfromcat/docs-check-action
Nov 24, 2025

Conversation

@DevelopmentCats
Copy link
Contributor

@DevelopmentCatsDevelopmentCats commentedNov 24, 2025
edited
Loading

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:

  • Introduces.github/workflows/doc-check.yaml to automate documentation review for PRs, triggered by thedoc-check label or manual dispatch.

Workflow Features:

  • Determines PR context and extracts changed files to build a detailed prompt for the AI agent, including steps for analyzing changes and searching documentation.
  • Integrates with thecoder/create-task-action to create a Coder Task that reviews the PR and posts documentation recommendations as a comment.
  • Outputs a summary of the documentation check task, including links and status, for visibility in the workflow run.

@DevelopmentCatsDevelopmentCats added the doc-checkAssign this label to PRs to check for any doc changes. labelNov 24, 2025
@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@codercoder deleted a comment fromgithub-actionsbotNov 24, 2025
@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@github-actions
Copy link

github-actionsbot commentedNov 24, 2025
edited
Loading

@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

Reason: Internal CI/CD workflow - No user-facing impact

This PR adds a GitHub Actions workflow (doc-check.yaml) that is purely for internal development automation. This workflow:

  • Triggers when adoc-check label is added to PRs or via manual workflow dispatch
  • Creates a Coder task to analyze PRs for documentation needs
  • Posts recommendations as PR comments

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.github/workflows/ and is only used by Coder maintainers during the development process.

@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

Reason: Internal CI/CD tooling only - no user-facing impact

This PR adds an internal GitHub Actions workflow (doc-check.yaml) that automates documentation review for pull requests. This is internal development infrastructure that:

  • Triggers on thedoc-check label or manual workflow dispatch
  • Uses Coder's internal task creation system to analyze PRs
  • Comments on PRs with documentation recommendations

Why no docs needed:

  1. Internal automation only - This workflow is for Coder maintainers, not users
  2. No user-facing features - Users don't interact with this workflow
  3. No API/CLI changes - No changes to Coder's product surface area
  4. Development tooling - Similar to other CI workflows in.github/workflows/ that aren't documented in user docs

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

Copilot finished reviewing on behalf ofDevelopmentCatsNovember 24, 2025 21:41
Copy link
Contributor

CopilotAI left a 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.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

This PR adds a GitHub Actions workflow (doc-check.yaml) for internal CI/CD automation to help contributors identify when documentation updates are needed. This is an internal development tool and does not require user-facing documentation because:

  1. Internal Process: The workflow is part of the Coder team's development and CI/CD infrastructure
  2. Not User-Facing: External users and contributors won't directly interact with or need to understand this automated check
  3. Self-Documenting: The workflow includes clear inline comments and prompts that explain its purpose and usage
  4. Optional Label: Contributors can choose to use thedoc-check label to trigger this automation, but it's not a feature they need to learn or configure

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

@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

Reason: Internal changes only - No user-facing impact

This PR adds a GitHub Actions workflow (.github/workflows/doc-check.yaml) that is purely an internal CI/CD automation tool. The workflow:

  • Triggers on thedoc-check label or manual dispatch
  • Creates Coder tasks to analyze PRs for documentation needs
  • Posts comments back to PRs with documentation recommendations

This is an internal development workflow that:

  1. Not user-facing: Contributors don't need to understand or interact with this workflow directly
  2. Self-documenting: The workflow itself contains clear inline comments and structured steps
  3. Internal automation: Part of the repository's CI/CD infrastructure, similar to other workflows in.github/workflows/

The existing contributing documentation indocs/about/contributing/CONTRIBUTING.md already covers the general development workflow and PR process. Internal GitHub Actions workflows are typically not documented in user-facing or contributor documentation unless they require specific contributor interaction (like thepr-deploy.yaml workflow which is mentioned because it creates preview deployments).


This comment was generated by an AI Agent throughCoder Tasks

@DevelopmentCatsDevelopmentCats added doc-checkAssign this label to PRs to check for any doc changes. and removed doc-checkAssign this label to PRs to check for any doc changes. labelsNov 24, 2025
@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

Reason: Internal automation workflow - no user-facing impact

Analysis:
This PR adds a new GitHub Actions workflow (.github/workflows/doc-check.yaml) that automates documentation review for pull requests. This is an internal development tool that:

  1. Triggers on thedoc-check label or manual workflow dispatch
  2. Creates a Coder Task to analyze PRs for documentation needs
  3. Posts automated comments with documentation recommendations

This workflow is not user-facing and does not require documentation because:

  • It's an internal CI/CD automation for maintainers
  • Users don't interact with or need to know about this workflow
  • It's similar to other internal workflows in.github/workflows/ that are not documented
  • The workflow itself analyzes and documents other changes

If this workflow were to be made available for external contributors or required special setup, documentation could be added todocs/about/contributing/CONTRIBUTING.md under a CI/CD or automation section, but that's not necessary for internal-only automation.


This comment was generated by an AI Agent throughCoder Tasks

@DevelopmentCatsCoder
Copy link
ContributorAuthor

📚 Documentation Check

✨ No Changes Needed

This PR adds a new GitHub Actions workflow (.github/workflows/doc-check.yaml) that automates documentation review for pull requests. This is aninternal development tool with no user-facing impact.

Reasoning:

  • Internal CI/CD workflow - Not a user-facing feature that requires documentation
  • Development automation - Used by maintainers to trigger automated documentation checks via thedoc-check label
  • No API/CLI changes - Does not modify any public interfaces, commands, or user behaviors
  • Infrastructure-only - Similar to other CI workflows in.github/workflows/ which are not documented in user-facing docs

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

@DevelopmentCatsDevelopmentCats merged commitf08cb2f intomainNov 24, 2025
28 checks passed
@DevelopmentCatsDevelopmentCats deleted the cat/docs-check-action branchNovember 24, 2025 23:05
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsNov 24, 2025
@matifali
Copy link
Member

I think we should keep updating the single comment instead of making a new comment on each new commit

Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.

Reviewers

Copilot code reviewCopilotCopilot left review comments

@david-fraleydavid-fraleydavid-fraley approved these changes

@matifalimatifaliAwaiting requested review from matifali

Assignees

@DevelopmentCatsDevelopmentCats

Labels

doc-checkAssign this label to PRs to check for any doc changes.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@DevelopmentCats@matifali@david-fraley

[8]ページ先頭

©2009-2025 Movatter.jp