- Notifications
You must be signed in to change notification settings - Fork1k
feat: add GitHub Action for automatic docs preview comments#20254
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
Draft
david-fraley wants to merge3 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+93 −0
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
This action automatically comments on pull requests with preview linkswhen documentation files in the docs/ directory are modified.Features:- Triggers on PR open, synchronize, and reopen events- Only runs when docs/ markdown files are changed- URI-encodes branch names properly (e.g., slashes become %2F)- Creates or updates a single comment with all changed doc links- Preview URLs follow format:https://coder.com/docs/@{encoded-branch}/{doc-path}Example: Branch 'df/claude-code-mod-v3' with changes to'docs/ai-coder/tasks-core-principles.md' will generate:https://coder.com/docs/@df%2Fclaude-code-mod-v3/ai-coder/tasks-core-principles
Use environment variables instead of direct template expansion in bashcommands to prevent potential code injection attacks through branch names.This addresses the zizmor linter check for template injection vulnerabilities.
- Add persist-credentials: false to checkout action to prevent credential leaks- Quote GITHUB_OUTPUT variable to fix shellcheck warningsAddresses artipacked and shellcheck findings from CI linter.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
1 participant
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 GitHub Action that automatically comments on pull requests with preview links when documentation files in the
docs/directory are modified.Implementation Details
The action:
docs/are changeddf/claude-code-mod-v3→df%2Fclaude-code-mod-v3)https://coder.com/docs/@{encoded-branch}/{doc-path}Example
For a branch named
df/claude-code-mod-v3with changes todocs/ai-coder/tasks-core-principles.md, the action will comment:📚 Documentation Preview Links
The following documentation pages have been modified and are available for preview:
docs/ai-coder/tasks-core-principles.mdPreview links are generated for branch:
df/claude-code-mod-v3Testing
The workflow has been tested locally for:
Resolves
Addresses the request from@david-fraley to automatically comment preview links for documentation changes.