Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.71 KB

File metadata and controls

53 lines (34 loc) · 1.71 KB

📖 Daily Documentation Updater

For an overview of all available workflows, see the main README.

Automatically review and update documentation based on recent code changes and merged pull requests

The Daily Documentation Updater workflow scans changes from the last 24 hours, identifies documentation gaps, and creates pull requests with updates to reflect new features, modifications, or deprecations.

Installation

# Install the 'gh aw' extension
gh extension install github/gh-aw

# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/daily-doc-updater

This walks you through adding the workflow to your repository.

How It Works

graph LR
    A[Scan Recent PRs] --> B[Find Code Changes]
    B --> C[Identify Doc Gaps]
    C --> D{Updates Needed?}
    D -->|Yes| E[Update Documentation]
    E --> F[Create PR]
    D -->|No| G[Report: Docs Current]
Loading

The workflow follows your repository's existing documentation structure and style.

Usage

Configuration

This workflow requires no configuration and works out of the box. You can customize the time range, change types to document, and PR settings.

After editing run gh aw compile to update the workflow and commit all changes to the default branch.

Commands

You can start a run of this workflow immediately by running:

gh aw run daily-doc-updater

Triggering CI on Pull Requests

To automatically trigger CI checks on PRs created by this workflow, configure an additional repository secret GH_AW_CI_TRIGGER_TOKEN. See the triggering CI documentation for setup instructions.