Add daily workflow to refresh generated developer docs#35775
Add daily workflow to refresh generated developer docs#35775antiguru merged 3 commits intoMaterializeInc:mainfrom
Conversation
Adds a GitHub Actions workflow that runs .claude/commands/update-docs.md daily at 06:00 UTC via claude-code-action. The workflow detects stale, orphaned, and new doc files under doc/developer/generated/ and creates an auto-merge PR with the updates. Write scope is enforced at two levels: Claude's allowed tools are restricted to read-only commands plus Edit/Read/Glob/Grep, and git add is scoped to doc/developer/generated/ only. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Thanks for opening this PR! Here are a few tips to help make the review process smooth for everyone. PR title guidelines
Pre-merge checklist
|
Set persist-credentials: false on checkout and configure the remote URL with the token explicitly for the push step. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
def-
left a comment
There was a problem hiding this comment.
Do we really want to have this live in the Materialize repo? What about reviewing the generated developer docs? I'm worried it might degenerate and we wouldn't even notice.
|
I think it makes sense to have this run daily - for these docs to be useful they have to be up to date. Automerge is a bit of an experiment. But let's do the experiment and take stock after a month? (I have put a reminder on my calendar.) One thing that might help reduce drift is adding instructions to update-docs.md to make minimizing edits a first-order objective, along side updating the text to reflect the code file changes. Claude came up with this as a human and LLM-friendly expression of this idea: (And it offered this as a rewording/formatting of the existing section on style: ) |
|
I think the automerge should only fire after someone approves the PR, unless the user generating the PR is in the exception list. Easy to change, but my intention was that we have a human in the loop for a while. And, we should check that it behaves as intended. |
bosconi
left a comment
There was a problem hiding this comment.
Looks good. Let's see how much drift we get!
…rkflow - Add surgical editing and writing style guidelines to update-docs.md to reduce unnecessary doc churn (bosconi's suggestion) - Remove automerge: require human review before merging (antiguru's feedback) - Add review checklist and reviewer assignment to generated PRs - Reuse existing open PR branch instead of creating new ones daily Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Incorporated the feedback; please check 0192ec8 for details. |
Summary
.claude/commands/update-docs.mddaily at 06:00 UTC viaclaude-code-actiondoc/developer/generated/git addTest plan
workflow_dispatchand verify it creates a PR with onlydoc/developer/generated/changes🤖 Generated with Claude Code