Conversation
|
Merging to
|
abhimehro
deleted the
add-workflow-.github-workflows-daily-doc-updater.md-9402
branch
|
Note Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported. |
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
There was a problem hiding this comment.
Pull request overview
Adds a new gh-aw “agentic workflow” intended to scan recent merged PRs/commits and propose documentation updates via an automated (safe-outputs) pull request.
Changes:
- Adds the
daily-doc-updaterworkflow source definition (.md) with the agent prompt/instructions and tool allowlist. - Adds the auto-generated compiled workflow (
.lock.yml) produced bygh aw compile.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| .github/workflows/daily-doc-updater.md | Defines the daily documentation-updater agent workflow configuration, tool allowlist, and operating instructions. |
| .github/workflows/daily-doc-updater.lock.yml | Generated GitHub Actions workflow compiled from the source .md (execution plumbing for gh-aw + safe-outputs). |
| draft: false | ||
| auto-merge: true |
There was a problem hiding this comment.
safe-outputs.create-pull-request is configured with draft: false and auto-merge: true. In this repo’s other agentic workflows, generated PRs are created as drafts (no auto-merge), which provides a safety gate for human review before merging automation output. Unless there’s a specific reason to bypass review here, consider switching back to draft PRs and disabling auto-merge to match the existing workflow pattern.
| draft: false | |
| auto-merge: true | |
| draft: true | |
| auto-merge: false |
| on: | ||
| schedule: | ||
| # Every day at 6am UTC | ||
| - cron: daily |
There was a problem hiding this comment.
The schedule configuration is inconsistent/misleading: the comment says "Every day at 6am UTC" but the workflow uses the gh-aw friendly value cron: daily (which compiles to a scattered daily cron time). Either set an explicit cron for 06:00 UTC, or change this to the repo’s existing on: { schedule: daily } pattern and update/remove the 6am comment so it matches reality.
| - cron: daily | |
| - cron: '0 6 * * *' |
| - "find docs -name '*.md' -o -name '*.mdx'" | ||
| - "find docs -maxdepth 1 -ls" | ||
| - "find docs -name '*.md' -exec cat {} +" | ||
| - "grep -r '*' docs" |
There was a problem hiding this comment.
The bash allowlist includes grep -r '*' docs, which is not a valid grep pattern (* is an invalid regex on its own) and will fail if run. Also, this repository currently has no top-level docs/ directory, so all of the find docs ... commands will error as written. Consider either updating the workflow to target the repo’s actual documentation locations (e.g., README.md / SECURITY.md / WARP.md) or guard these commands with a test -d docs check and use a valid grep pattern (e.g., search for \* literally or use a real term).
| - "find docs -name '*.md' -o -name '*.mdx'" | |
| - "find docs -maxdepth 1 -ls" | |
| - "find docs -name '*.md' -exec cat {} +" | |
| - "grep -r '*' docs" | |
| - "test -d docs && find docs -name '*.md' -o -name '*.mdx' || true" | |
| - "test -d docs && find docs -maxdepth 1 -ls || true" | |
| - "test -d docs && find docs -name '*.md' -exec cat {} + || true" | |
| - "test -d docs && grep -R '\\*' docs || true" |
|
|
||
| ```bash | ||
| # Load the documentation instructions | ||
| cat .github/instructions/documentation.instructions.md |
There was a problem hiding this comment.
This workflow instructs the agent to cat .github/instructions/documentation.instructions.md, but .github/instructions/ does not exist in this repository. As-is, the agent will hit a hard failure or waste time on missing guidance. Point this to an existing instructions file in the repo (or add the referenced file) and ensure the path is correct.
| cat .github/instructions/documentation.instructions.md | |
| cat .github/shared-instructions.md |
| ### 4. Identify Documentation Gaps | ||
|
|
||
| Review the documentation in the `docs/src/content/docs/` directory: | ||
|
|
||
| - Check if new features are already documented | ||
| - Identify which documentation files need updates | ||
| - Determine the appropriate documentation type (tutorial, how-to, reference, explanation) | ||
| - Find the best location for new content | ||
|
|
||
| Use bash commands to explore documentation structure: | ||
|
|
||
| ```bash | ||
| find docs/src/content/docs -name '*.md' -o -name '*.mdx' | ||
| ``` | ||
|
|
||
| ### 5. Update Documentation | ||
|
|
||
| For each missing or incomplete feature documentation: | ||
|
|
||
| 1. **Determine the correct file** based on the feature type: | ||
| - CLI commands → `docs/src/content/docs/setup/cli.md` | ||
| - Workflow reference → `docs/src/content/docs/reference/` | ||
| - How-to guides → `docs/src/content/docs/guides/` | ||
| - Samples → `docs/src/content/docs/samples/` |
There was a problem hiding this comment.
The workflow’s documentation targets (e.g., docs/src/content/docs/, docs/src/content/docs/setup/cli.md, etc.) don’t exist in this repository, so the agent won’t be able to follow these steps or will create a bunch of new structure unexpectedly. Update these paths to match the repo’s actual documentation layout, or change the instructions to explicitly state what files should be considered the canonical docs for this project.
Add agentic workflow daily-doc-updater