Add Daily Documentation Healer workflow (self-healing DDUw companion)#18375
Add Daily Documentation Healer workflow (self-healing DDUw companion)#18375
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
| on: | ||
| schedule: | ||
| # Every weekday at 8am UTC (after DDUw runs at ~3am) | ||
| - cron: "0 8 * * 1-5" |
There was a problem hiding this comment.
Changed to cron: daily shorthand (matching DDUw style) in c87caf7.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@pelikhan copilot-setup-steps looks to be failing from missing dependency. |
|
Hey
|
| Check | Result |
|---|---|
| On-topic | ✅ Adds a new agentic workflow — aligns with project focus |
| Focused | ✅ Three files, single clear purpose |
| New dependencies | ✅ None |
| Has description | ✅ PR body includes checklist and issue reference |
| Has tests | ❌ No test files included |
| Lines changed | 1,611 |
Missing tests: Workflow definitions in this repo are typically validated via CI (make agent-finish). The PR comment notes a failing copilot-setup-steps step, suggesting the workflow itself may have issues that need fixing before it could be accepted.
Recommended Path Forward
- Check whether this work was intentionally assigned — if
@pelikhandid not deliberately intend to implement Feature Request: Self Healing Updates to Fix Documentation Workflow issues #18372, this PR should be closed. - If the feature is wanted, a new, higher-quality issue should be opened and explicitly approved by a core team member before re-implementing.
- Fix the CI failure reported in the PR comments (missing dependency in
copilot-setup-steps).
If you'd like to address the above and re-attempt once the issue is properly approved, here's a prompt you can use:
The PR github/gh-aw#18375 (Daily Documentation Healer) was flagged because it implements a rejected issue (#18372, labeled spam/not_planned).
Please do the following:
1. Check with the core team whether this workflow is actually desired. If yes, ensure a new, approved issue exists with a detailed agentic plan.
2. Investigate and fix the CI failure in the copilot-setup-steps job (see: https://github.com/github/gh-aw/actions/runs/22406316814/job/64867044831#step:36:52).
3. Once CI passes, ensure `make agent-finish` runs cleanly (build, test, lint, recompile).
4. If applicable, add any workflow-level tests or validation steps that follow the patterns used by other workflows in .github/workflows/.
Generated by Contribution Check
| reviewers: [copilot] | ||
| draft: false | ||
| auto-merge: true |
There was a problem hiding this comment.
Removed reviewers, draft, and auto-merge from the create-pull-request safe-output in aaeab00.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a new “Daily Documentation Healer” companion workflow intended to detect documentation gaps missed by the existing Daily Documentation Updater (DDUw) and to propose corrective documentation/heuristic updates.
Changes:
- Introduces a new agentic workflow definition for “Daily Documentation Healer” and compiles it to a locked GitHub Actions workflow.
- Configures safe-output behaviors for creating PRs/issues (without reviewers/draft/auto-merge settings).
- Updates the agent factory status documentation to include the new workflow entry.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/src/content/docs/agent-factory-status.mdx |
Adds the new workflow to the published workflow/status table. |
.github/workflows/daily-doc-healer.md |
Defines the new healer workflow prompt/instructions, tools, and safe-outputs configuration. |
.github/workflows/daily-doc-healer.lock.yml |
Generated locked workflow YAML compiled from the new .md workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| For each issue found: | ||
| - Record the issue number, title, body, and closing date. | ||
| - Check whether a DDUw-created PR (label `documentation automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window. If such a PR exists, DDUw likely already handled it — skip this issue. |
There was a problem hiding this comment.
The workflow text treats documentation automation as a single label when checking for DDUw-created PRs. In this repo the safe-outputs configuration applies two separate labels (documentation and automation), so a GitHub search using label:"documentation automation" would not match. Update this step to check for both labels (e.g., label:documentation label:automation) or rely on the [docs] title prefix + author/bot label combination.
| - Check whether a DDUw-created PR (label `documentation automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window. If such a PR exists, DDUw likely already handled it — skip this issue. | |
| - Check whether a DDUw-created PR (labels `documentation` and `automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window (for example, using a search like `label:documentation label:automation`). If such a PR exists, DDUw likely already handled it — skip this issue. |
| ```bash | ||
| find docs/src/content/docs -name '*.md' -o -name '*.mdx' | ||
| ``` |
There was a problem hiding this comment.
The bash command suggested here (find docs/src/content/docs ...) is not included in this workflow’s bash allowlist (which currently only allows find docs -name '*.md' -o -name '*.mdx'). In strict mode this is likely to be blocked at runtime. Either adjust the instructions to use the allowed find docs ... command, or add the find docs/src/content/docs -name '*.md' -o -name '*.mdx' variant to the tools.bash allowlist.
.github/workflows/daily-doc-healer.md- self-healing documentation workflow.github/workflows/daily-doc-healer.lock.ymldocs/src/content/docs/agent-factory-status.mdxdailycron shorthand (matching DDUw style) instead of explicit cron expressionreviewers,draft, andauto-mergefromcreate-pull-requestsafe-output configOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.