Add in-progress preview comment to deploy workflow#27
Merged
Conversation
Phase II (docs-deploy) runs on workflow_run and isn't visible as a PR check, making it hard to tell when a preview is being built. This adds a pre-comment job that updates the preview comment to show an in-progress indicator immediately after preflight, running in parallel with the build. The final comment job depends on pre-comment to avoid race conditions. Also adds # language= markers to inline scripts for better IDE support. Made-with: Cursor
reakaleek
approved these changes
Mar 25, 2026
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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
pre-commentjob todocs-deploy.ymlthat runs in parallel withbuild(right afterpreflight) to update the PR preview comment with an in-progress indicator and a link to the workflow run. Since phase II triggers onworkflow_runand isn't visible as a PR check, this gives reviewers immediate feedback that a preview build/deploy is underway.commentjob now depends onpre-commentto prevent race conditions when finding/creating the comment.# language=markers to inline scripts for better syntax highlighting in IDEs.Test plan
docs-eng-playgroundthat triggers a docs build and verify the preview comment updates to show "Building and deploying preview..." with a link to the workflow rundisable-comments: true) skips bothpre-commentandcommentMade with Cursor