Skip to content

Commit 6d897e2

Browse files
authored
chore(workflows): update doc freshness checker to open PRs every 4 hours (#446)
1 parent 171c445 commit 6d897e2

3 files changed

Lines changed: 82 additions & 47 deletions

File tree

.github/aw/actions-lock.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@
1515
"version": "v9.0.0",
1616
"sha": "d746ffe35508b1917358783b479e04febd2b8f71"
1717
},
18-
"github/gh-aw-actions/setup@v0.62.0": {
19-
"repo": "github/gh-aw-actions/setup",
20-
"version": "v0.62.0",
21-
"sha": "b2c35f34e1013dd9ed2a84c559e2b2fec9ad38e6"
22-
},
2318
"github/gh-aw/actions/setup@v0.68.1": {
2419
"repo": "github/gh-aw/actions/setup",
2520
"version": "v0.68.1",

.github/workflows/doc-freshness-check.lock.yml

Lines changed: 69 additions & 29 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/doc-freshness-check.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
on:
3-
schedule: daily on weekdays
3+
schedule: every 4 hours
44
description: Checks that documentation stays consistent with code structure and CLI commands
55
permissions:
66
contents: read
@@ -12,7 +12,7 @@ tools:
1212
network:
1313
allowed: [defaults, rust]
1414
safe-outputs:
15-
create-issue:
15+
create-pull-request:
1616
max: 1
1717
---
1818

@@ -22,7 +22,7 @@ You are a technical documentation auditor for the **ado-aw** project — a Rust
2222

2323
## Your Task
2424

25-
Audit the project documentation for accuracy and completeness by comparing docs against the actual codebase. If you find meaningful drift, create an issue detailing what needs updating.
25+
Audit the project documentation for accuracy and completeness by comparing docs against the actual codebase. If you find meaningful drift, create a pull request with the documentation updates.
2626

2727
## Documentation Files
2828

@@ -117,24 +117,24 @@ This file is the primary guide AI agents use when creating new workflow files. D
117117

118118
## Decision Criteria
119119

120-
**Create an issue** if you find any of the following:
120+
**Create a pull request** if you find any of the following:
121121
- 2+ documentation inconsistencies across any files
122122
- Any single critical inconsistency (wrong CLI syntax, missing required field documentation, incorrect defaults)
123123
- **Any inconsistency in `prompts/create-ado-agentic-workflow.md`** — this file directly drives agent behavior, so even a single inaccuracy is high-priority
124124

125-
**Do NOT create an issue** if documentation is accurate or only has trivial differences (whitespace, comment wording).
125+
**Do NOT create a pull request** if documentation is accurate or only has trivial differences (whitespace, comment wording).
126126

127-
## Issue Format
127+
## Pull Request Format
128128

129-
If creating an issue, use this structure:
129+
If creating a pull request, use this structure:
130130

131-
**Title**: `📝 Documentation drift detected — [brief summary]`
131+
**Title**: `docs: fix documentation drift — [brief summary]`
132132

133133
**Body**:
134134
```markdown
135135
## Documentation Freshness Audit
136136

137-
The weekly documentation audit found the following inconsistencies between code and documentation:
137+
This audit found the following inconsistencies between code and documentation:
138138

139139
### Findings
140140

@@ -146,11 +146,11 @@ The weekly documentation audit found the following inconsistencies between code
146146

147147
[Detailed description of each finding with specific line references]
148148

149-
### Suggested Fixes
149+
### Applied Fixes
150150

151-
- [ ] [Specific fix 1]
152-
- [ ] [Specific fix 2]
151+
- [x] [Specific fix 1]
152+
- [x] [Specific fix 2]
153153

154154
---
155-
*This issue was created by the automated documentation freshness check.*
155+
*This pull request was created by the automated documentation freshness check.*
156156
```

0 commit comments

Comments
 (0)