ci: consolidate preview comments into one auto-updating PR comment#12
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
ci: consolidate preview comments into one auto-updating PR comment#12devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
- Rewrite preview-docs.yml to use a matrix generate job + a single comment job - Each matrix job uploads its preview URL as an artifact - The comment job collects all URLs and posts one consolidated table - Uses comment_tag + upsert mode to auto-update on each push - Add graphql example to all workflow matrices (check, preview, publish) Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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
Rewrites the preview workflow to post a single consolidated comment (instead of one per matrix project) that auto-updates on each push. Also adds the
graphqlexample to all three workflow matrices (check, preview, publish).Changes:
generate-preview(matrix, runs in parallel) uploads each preview URL as an artifact, thencomment(single job) collects all URLs and posts one table comment usingcomment_tag: preview-docs+mode: upsertgraphqlto the project matrixThe resulting PR comment looks like:
docs-startergraphqli18nmulti-source/homepageversioningReview & Testing Checklist for Human
graphqlexample generates a valid preview URLNotes
ref: ${{ github.event.pull_request.head.sha }}instead of manual fetch + checkoutgit diff+ the/api/fern-docs/get-slug-for-fileendpoint) to keep the comment focused on preview URLsif: ${{ !cancelled() }}so it runs even if some preview generations fail, showing:warning: Failedfor those entriesLink to Devin session: https://app.devin.ai/sessions/4482e9f954d04c2cae29bfb4731b896d
Requested by: @devalog