- Notifications
You must be signed in to change notification settings - Fork1k
docs: add docs preview GitHub action#17317
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Creates a simplified docs preview action that comments on PRs with Vercel preview links.The action shows changed files and highlights newly added documentation from manifest.json.🤖 Generated with [Claude Code](https://claude.ai/code)Co-Authored-By: Claude <noreply@anthropic.com>
…o use the same SHA and version (v45.0.7) that the docs-ci.yaml workflow uses.\n\n\ud83e\udd16 Generated with [Claude Code](https://claude.ai/code)\n\nCo-Authored-By: Claude <noreply@anthropic.com>\
…d to match patterns from the successful pr-deploy.yaml workflow:\n- Added job-level pull-requests write permission\n- Added explicit env var for PR_NUMBER\n- Added explicit GITHUB_TOKEN environment variable\n- Added reactions-edit-mode for consistency\n\n\ud83e\udd16 Generated with [Claude Code](https://claude.ai/code)\n\nCo-Authored-By: Claude <noreply@anthropic.com>\
testing against this PR in#17319
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Do we plan to reuse this action anywhere else? If not I would move it to the main workflow file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
this PR's just to get it started - we've got another PR with workflow improvements in#17322
Combines features from PRs#17317,#17322, and#17370:- Adds Vale style checking for documentation- Creates a reusable workflow for documentation validation- Optimizes PR checks and post-merge validation- Adds automatic GitHub issue creation for broken links- Updates all documentation checks to run in a structured mannerThis PR supersedes:- PR#17317: Docs Preview GitHub Action- PR#17322: Shared Docs GitHub Action- PR#17370: Vale Style Checking and Docs Workflow Improvements
replaced by#17522 |
Uh oh!
There was an error while loading.Please reload this page.
Summary
This PR adds a simplified docs preview GitHub action that comments on PRs with Vercel preview links when documentation changes. It improves upon the more complex implementation in PR#17282 by:
The action will:
Future iterations will:
Test plan
🤖 Generated withClaude Code