docs: add docs preview GitHub action #17317
Closed
Conversation
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
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
|
This was referenced Apr 9, 2025
matifali
reviewed
Apr 10, 2025
There was a problem hiding this comment.
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.
this PR's just to get it started - we've got another PR with workflow improvements in #17322
EdwardAngert
added a commit
that referenced
this pull request
Apr 23, 2025
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 manner This 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 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
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 with Claude Code