Skip to content

Commit 40ce328

Browse files
authored
Repository Quality Improver: weekday schedule + issue output (#228)
1 parent c57712f commit 40ce328

2 files changed

Lines changed: 23 additions & 26 deletions

File tree

β€Ždocs/repository-quality-improver.mdβ€Ž

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> For an overview of all available workflows, see the [main README](../README.md).
44
5-
The [Repository Quality Improver workflow](../workflows/repository-quality-improver.md?plain=1) analyzes your repository from a different quality angle every day, producing a discussion with findings and actionable improvement tasks.
5+
The [Repository Quality Improver workflow](../workflows/repository-quality-improver.md?plain=1) analyzes your repository from a different quality angle every weekday, producing an issue with findings and actionable improvement tasks.
66

77
## Installation
88

@@ -18,15 +18,15 @@ Then compile:
1818
gh aw compile
1919
```
2020

21-
> **Note**: This workflow posts results as GitHub Discussions. Make sure Discussions are enabled in your repository settings, and update the `category` field in the workflow to match an existing discussion category in your repo.
21+
> **Note**: This workflow creates GitHub Issues with the `quality` and `automated-analysis` labels.
2222
2323
## What It Does
2424

2525
The Repository Quality Improver runs on weekdays and:
2626

2727
1. **Selects a Focus Area** β€” Picks a different quality dimension each run, using a rotating strategy to ensure broad, diverse coverage over time
2828
2. **Analyzes the Repository** β€” Examines source code, configuration, tests, and documentation from the chosen angle
29-
3. **Produces a Discussion** β€” Posts a structured report with findings, metrics, and 3–5 actionable improvement tasks
29+
3. **Creates an Issue** β€” Posts a structured report with findings, metrics, and 3–5 actionable improvement tasks
3030
4. **Tracks History** β€” Remembers previous focus areas (using cache memory) to avoid repetition and maximize coverage
3131

3232
## How It Works
@@ -41,7 +41,7 @@ graph LR
4141
D --> G[Analyze Repository]
4242
E --> G
4343
F --> G
44-
G --> H[Generate Discussion Report]
44+
G --> H[Create Issue Report]
4545
H --> I[Update Cache Memory]
4646
````
4747

@@ -55,16 +55,16 @@ The workflow follows a deliberate diversity strategy across runs:
5555

5656
Over ten runs, the agent will typically explore 6–7+ unique quality dimensions.
5757

58-
### Output: GitHub Discussions
58+
### Output: GitHub Issues
5959

60-
Each run produces one discussion containing:
60+
Each run produces one issue containing:
6161

6262
- **Executive Summary** β€” 2–3 paragraphs of key findings
6363
- **Full Analysis** β€” Detailed metrics, strengths, and areas for improvement (collapsed)
6464
- **Improvement Tasks** β€” 3–5 concrete, prioritized tasks with file-level specificity
6565
- **Historical Context** β€” Table of previous focus areas for reference
6666

67-
You can use the `/plan` command on the discussion to automatically break the tasks into trackable GitHub issues.
67+
You can comment on the issue to request follow-up actions or add it to a project board for tracking.
6868

6969
## Example Reports
7070

@@ -78,10 +78,10 @@ The workflow uses these default settings:
7878

7979
| Setting | Default | Description |
8080
|---------|---------|-------------|
81-
| Schedule | Weekdays at 1 PM UTC | When to run the analysis |
82-
| Discussion category | `General` | Category for posted discussions |
83-
| Max discussions per run | 1 | Prevents duplicate reports |
84-
| Discussion expiry | 2 days | Older discussions are closed when a new one is posted |
81+
| Schedule | Daily on weekdays | When to run the analysis |
82+
| Issue labels | `quality`, `automated-analysis` | Labels applied to created issues |
83+
| Max issues per run | 1 | Prevents duplicate reports |
84+
| Issue expiry | 2 days | Older issues are closed when a new one is posted |
8585
| Timeout | 20 minutes | Per-run time limit |
8686

8787
## Customization
@@ -91,24 +91,23 @@ gh aw edit repository-quality-improver
9191
```
9292

9393
Common customizations:
94-
- **Change discussion category** β€” Set the `category` field in `safe-outputs.create-discussion` to a category that exists in your repo's Discussions settings
94+
- **Change issue labels** β€” Set the `labels` field in `safe-outputs.create-issue` to labels that exist in your repository
9595
- **Adjust the schedule** β€” Change the cron to run less frequently if your codebase changes slowly
9696
- **Add custom standard areas** β€” Extend the standard categories list with areas relevant to your project
9797

9898
## Tips for Success
9999

100-
1. **Enable GitHub Discussions** β€” The workflow requires Discussions to be turned on in your repository settings
101-
2. **Use `/plan` on reports** β€” Pair this workflow with the [Plan Command](plan.md) to automatically turn discussion tasks into trackable issues
100+
1. **Review open issues** β€” Check the labeled issues regularly to pick up quick wins
101+
2. **Add issues to a project board** β€” Track improvement tasks using GitHub Projects for visibility
102102
3. **Let the diversity algorithm work** β€” Avoid overriding the focus area too frequently; the rotating strategy ensures broad coverage over time
103-
4. **Review weekly** β€” Check the weekly discussion thread to pick up any quick wins
103+
4. **Review weekly** β€” Check recent issues to pick up any quick wins
104104

105105
## Source
106106

107107
This workflow is adapted from [Peli's Agent Factory](https://github.github.io/gh-aw/blog/2026-01-13-meet-the-workflows-continuous-improvement/), where it achieved a 62% merge rate (25 merged PRs out of 40 proposed) via a causal discussion β†’ issue β†’ PR chain.
108108

109109
## Related Workflows
110110

111-
- [Plan Command](plan.md) β€” Turn discussion tasks into actionable sub-issues with `/plan`
112111
- [Daily File Diet](daily-file-diet.md) β€” Targeted refactoring for oversized files
113112
- [Code Simplifier](code-simplifier.md) β€” Simplify recently modified code
114113
- [Duplicate Code Detector](duplicate-code-detector.md) β€” Find and remove code duplication

β€Žworkflows/repository-quality-improver.mdβ€Ž

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
name: Repository Quality Improver
33
description: Daily analysis of repository quality focusing on a different software development lifecycle area each run
44
on:
5-
schedule:
6-
- cron: "0 13 * * *" # Daily at 1 PM UTC
5+
schedule: daily on weekdays
76
workflow_dispatch:
87
permissions:
98
contents: read
@@ -20,11 +19,10 @@ tools:
2019
toolsets:
2120
- default
2221
safe-outputs:
23-
create-discussion:
22+
create-issue:
2423
expires: 2d
25-
category: "General"
24+
labels: [quality, automated-analysis]
2625
max: 1
27-
close-older-discussions: true
2826
timeout-minutes: 20
2927
strict: true
3028

@@ -36,7 +34,7 @@ You are the Repository Quality Improvement Agent β€” an expert system that perio
3634

3735
## Mission
3836

39-
Daily or on-demand, select a focus area for repository improvement, conduct analysis, and produce a single discussion with actionable tasks. Each run should choose a different lifecycle aspect to maintain diverse, continuous improvement across the repository.
37+
Daily or on-demand, select a focus area for repository improvement, conduct analysis, and produce a single issue with actionable tasks. Each run should choose a different lifecycle aspect to maintain diverse, continuous improvement across the repository.
4038

4139
## Current Context
4240

@@ -276,9 +274,9 @@ find .github/workflows -name "*.yml" -exec wc -l {} \; | sort -rn | head -5
276274

277275
## Phase 2: Generate Improvement Report
278276

279-
Write a comprehensive report as a GitHub discussion with the following structure:
277+
Write a comprehensive report as a GitHub issue with the following structure:
280278

281-
**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The discussion title serves as h1, so start section headers at h3.
279+
**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The issue title serves as h1, so start section headers at h3.
282280

283281
```markdown
284282
### 🎯 Repository Quality Improvement Report β€” [FOCUS AREA]
@@ -320,7 +318,7 @@ Write a comprehensive report as a GitHub discussion with the following structure
320318

321319
### πŸ€– Suggested Improvement Tasks
322320

323-
The following actionable tasks address the findings above. Use `/plan` on this discussion to break them into trackable issues.
321+
The following actionable tasks address the findings above.
324322

325323
#### Task 1: [Short Description]
326324

@@ -385,7 +383,7 @@ A successful quality improvement run:
385383
- βœ… Selects a focus area using the diversity algorithm (60% custom, 30% standard, 10% reuse)
386384
- βœ… Determines the repository's primary language(s) and adapts analysis accordingly
387385
- βœ… Conducts thorough analysis of the selected area
388-
- βœ… Generates exactly one discussion with the report
386+
- βœ… Generates exactly one issue with the report
389387
- βœ… Includes 3–5 actionable tasks
390388
- βœ… Updates cache memory with run history
391389
- βœ… Maintains high diversity rate (aim for 60%+ custom or varied strategies)

0 commit comments

Comments
Β (0)