Skip to content

glossary-maintainer.md

Latest commit

 

History

History
60 lines (38 loc) · 1.95 KB

glossary-maintainer.md

File metadata and controls

60 lines (38 loc) · 1.95 KB

📖 Glossary Maintainer

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

Automatically maintain project glossary by scanning code changes and keeping technical terms up-to-date

The Glossary Maintainer workflow runs on weekdays to scan recent changes, identify new technical terminology, and create pull requests with glossary updates.

Installation

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

# Add the workflow to your repository
gh aw add-wizard githubnext/agentics/glossary-maintainer

This walks you through adding the workflow to your repository.

How It Works

graph LR
    A[Scan Recent Changes] --> B[Identify New Terms]
    B --> C[Check Glossary]
    C --> D{Updates Needed?}
    D -->|Yes| E[Add/Update Definitions]
    E --> F[Create PR]
    D -->|No| G[Report: Glossary Current]
Loading
  • Daily (Mon-Fri): Incremental scan of last 24 hours
  • Monday: Full scan of last 7 days for comprehensive review

The workflow locates your glossary file automatically (common paths: docs/glossary.md, GLOSSARY.md) and follows your existing structure and style.

Usage

Configuration

This workflow works out of the box. You can customize the glossary file path, scanning timeframe, 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 immediately:

gh aw run glossary-maintainer

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.

Learn More