Skip to content

DDUw: add open-issue cross-referencing, stale schema drift detection, and example validation #18555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Feb 26, 2026
Merged

DDUw: add open-issue cross-referencing, stale schema drift detection, and example validation #18555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6886c5
Initial plan
Copilot Feb 26, 2026
cea1a1b
DDUw improvement: add open issue cross-referencing, stale doc-code dr…
Copilot Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/daily-doc-updater.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions .github/workflows/daily-doc-updater.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ tools:
- "find docs -name '*.md' -exec cat {} +"
- "grep -r '*' docs"
- "git"
- "find pkg/parser/schemas -name '*.json'"
- "cat pkg/parser/schemas/*.json"

timeout-minutes: 45

Expand Down Expand Up @@ -68,6 +70,20 @@ Use the GitHub tools to:
- Review commits from the last 24 hours using `list_commits`
- Get detailed commit information using `get_commit` for significant changes

### 1b. Check Open Documentation Issues

Search for open issues labeled `documentation` that may represent unaddressed gaps:

```
repo:${{ github.repository }} is:issue is:open label:documentation
```

For each open issue:
1. Read the issue body to understand the described gap.
2. Check the referenced documentation file to verify the gap still exists.
3. If confirmed, include a fix in this run's PR and reference the issue with `Closes #NNN`.
4. If the gap is already fixed, note it (do not reopen or comment on the issue).

### 2. Analyze Changes

For each merged PR and commit, analyze:
Expand All @@ -76,6 +92,7 @@ For each merged PR and commit, analyze:
- **Features Removed**: Deprecated or removed functionality
- **Features Modified**: Changed behavior, updated APIs, or modified interfaces
- **Breaking Changes**: Any changes that affect existing users
- **Removed Features in Docs**: Search docs for references to properties, flags, or options that no longer exist in the current schema. Check `pkg/parser/schemas/` or run `gh aw compile` on representative workflows to confirm current valid properties.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions recommend running gh aw compile for schema/example validation, but this workflow’s bash tool allowlist doesn’t currently permit invoking gh aw compile. Either add an allowlist entry for gh aw compile (ideally with a constrained pattern) and recompile the lockfile, or adjust this guidance to only describe checks that can be performed with the currently allowed tools (e.g., schema JSON inspection).

This issue also appears on line 223 of the same file.

Suggested change
- **Removed Features in Docs**: Search docs for references to properties, flags, or options that no longer exist in the current schema. Check `pkg/parser/schemas/` or run `gh aw compile` on representative workflows to confirm current valid properties.
- **Removed Features in Docs**: Search docs for references to properties, flags, or options that no longer exist in the current schema. Use the JSON schemas in `pkg/parser/schemas/` (which you can inspect with the allowed tools) to confirm the currently valid properties.

Copilot uses AI. Check for mistakes.

Create a summary of changes that should be documented.

Expand Down Expand Up @@ -202,6 +219,8 @@ This PR updates the documentation based on features merged in the last 24 hours.
- **Use Proper Format**: Use the correct Diátaxis category and Astro Starlight syntax
- **Link References**: Include links to relevant PRs and issues where appropriate
- **Test Understanding**: If unsure about a feature, review the code changes in detail
- **Issue-Driven**: Proactively check open `documentation` issues — do not wait for them to be reported manually.
- **Validate Examples**: YAML frontmatter examples in docs must be structurally valid. When in doubt, test with `gh aw compile`.

## Important Notes

Expand Down