feat: Improve documentation suggestion workflow#487
Closed
Corey-T1000 wants to merge 1 commit intomainfrom
Closed
Conversation
Security improvements: - Add org membership validation for label-based triggers - Tighten allowedTools to explicit git/gh commands (no wildcards) - Fix DRY_RUN boolean-to-string type coercion bug - Add concurrency control (one run per issue) - Reduce fetch-depth to 1 (limit history exposure) - Restrict WebFetch to docs.authzed.com only UX improvements: - Add structured issue template for doc suggestions - Auto-create draft PR (instead of just link) - Include Vercel preview URL in issue comment - Request review from appropriate user (label adder or issue author) - Add timeout notification (cancelled jobs now notify users) - Add failure notification with workflow run link Trigger logic: - Org members with 'Docs' label: auto-runs on issue open - External users: requires org member to add 'approved' label - workflow_dispatch: dry_run=true skips label check for testing Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
CLA Assistant Lite bot: I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request |
Member
|
Closing in favor of #489 Most of the changes in this PR are changing intentional decisions and limits placed in the workflow currently. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the documentation suggestion workflow based on security review and usability feedback.
Security Improvements
Bash(git:*)wildcards with explicit commands (checkout, branch, add, commit, push, diff)docs.authzed.comonlyUX Improvements
doc-suggestion.ymltemplate with required fieldscontinue-on-errorto avoid silent failuresTrigger Logic
Docslabelapprovedlabel addedapprovedlabelTest Plan
dry_run=trueon existing issue → should analyze without changesapprovedlabel as org member to external issue → should triggerFiles Changed
.github/ISSUE_TEMPLATE/doc-suggestion.yml(new).github/workflows/claude.yml(modified)🤖 Generated with Claude Code