docs: fix review feedback in AGENTIC-WORKFLOWS.md and README.md#99
Conversation
Co-authored-by: zircote <307960+zircote@users.noreply.github.com>
1e11581
into
docs/add-agentic-workflows-documentation-0a5d09e5401bb94b
Code Coverage ReportOverall Coverage: 0% SummaryFull HTML report available in CI artifacts. |
There was a problem hiding this comment.
Pull request overview
This PR corrects inaccuracies in the agentic workflows documentation so the documented safe-outputs and workflow inventory match the actual GitHub Actions workflow definitions.
Changes:
- Updates the documented safe-outputs/behavior for CI Doctor and Daily Repository Status to align with the workflows’ configured outputs.
- Fixes the Diátaxis spelling in the ADR-0003 link text.
- Expands
docs/README.mdentries so all documented agentic workflows are listed.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/workflows/AGENTIC-WORKFLOWS.md | Adjusts safe-output descriptions for CI Doctor and Daily Repository Status; updates ADR-0003 link text. |
| docs/README.md | Updates workflow listings to include Daily Documentation Review and Daily Repository Status. |
|
|
||
| **Safe Outputs:** | ||
| - Creates issues with `[CI Doctor]` prefix | ||
| - Creates issues prefixed with the workflow name (for example, `CI Doctor`) |
There was a problem hiding this comment.
title-prefix: "${{ github.workflow }}" in .github/workflows/ci-doctor.md resolves to the workflow's configured name (in the compiled workflow this is CI Failure Doctor), not CI Doctor. The example here should match the actual workflow name or avoid a concrete example (e.g., describe it as "prefixed with ${{ github.workflow }}").
| - Creates issues prefixed with the workflow name (for example, `CI Doctor`) | |
| - Creates issues prefixed with the workflow name (via `${{ github.workflow }}`) |
| **Safe Outputs:** | ||
| - Creates discussions for status reports | ||
| - Can comment on stale issues | ||
| - Creates issues for status reports with `[repo-status]` title prefix |
There was a problem hiding this comment.
The Daily Repository Status workflow's safe-output title-prefix is defined as "[repo-status] " (note the trailing space). For copy/paste accuracy, consider reflecting the exact prefix here (including the space) or explicitly stating that a space follows the tag.
| - Creates issues for status reports with `[repo-status]` title prefix | |
| - Creates issues for status reports with `[repo-status] ` title prefix (note trailing space) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs/add-agentic-workflows-documentation-0a5d09e5401bb94b #99 +/- ##
==========================================================================================
Coverage 95.83% 95.83%
==========================================================================================
Files 9 9
Lines 6499 6499
==========================================================================================
Hits 6228 6228
Misses 271 271 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Four inaccuracies and omissions in the agentic workflows documentation identified during PR review.
Changes
[CI Doctor]brackets — the workflow usestitle-prefix: "${{ github.workflow }}"which expands without bracketscreate-discussion→create-issuewith accurate[repo-status]prefix andreport/daily-statuslabels; removed non-existentadd-commentsafe-output; fixed "discussions" → "GitHub issues" in the Features listDiataxis→Diátaxisin the ADR-0003 link (line 374)✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.