Document the GitHub Actions push-to-deploy flow for Composer apps - #8173
Merged
Conversation
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
WalkthroughThe documentation adds a deploy-on-push guide for GitHub Actions, OIDC authentication, production deployments, branch previews, and preview cleanup. Existing GitHub, CLI, Compute, Composer, and tutorial pages now reference this workflow. ChangesDeploy on push documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
🍈 Lychee Link Check Report112 links: ✅ All links are working!Full Statistics Table
|
The GitHub integration page described platform-side webhook builds
("push builds the pushed commit"), which is not how deploys work:
deploys run in the repository's own GitHub Actions through
prisma/cloud-deploy-action, while the connection contributes the OIDC
credential exchange and the branch lifecycle automation (preview
teardown on branch delete).
- Add compute/deploy-on-push.mdx: a walkthrough from a locally deployed
Composer app to push-to-deploy with per-branch preview stages,
validated end to end against a real pipeline on 2026-08-25.
- Rewrite compute/github.mdx around what the connection actually does,
including the two entry paths (Console adds the workflow via PR, the
CLI path does not) and the interactive-only git connect.
- Align branching, deployments, index, cli/v8/git, composer/deploying,
and the full-stack tutorial's next step with the real flow.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Apply the docs-writer skill's conventions to the new and rewritten pages: remove em dashes, contrast slogans, coined phrasings, and stacked absolutes; move failure notes inline with the step where the reader hits them instead of a separate troubleshooting section; trim the next-steps lists. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
kristof-siket
force-pushed
the
docs/composer-github-actions-flow
branch
from
August 25, 2026 14:04
698855e to
05ca829
Compare
kristof-siket
marked this pull request as ready for review
August 25, 2026 14:15
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
The GitHub integration docs described platform-side webhook builds ("Push → builds the pushed commit"). That is not how push-to-deploy works: deploys run in the repository's own GitHub Actions through prisma/cloud-deploy-action, while the repository connection provides the OIDC credential exchange and the branch lifecycle automation (platform branch creation, preview teardown on branch delete). This PR documents the real flow, based on an end-to-end walkthrough on 2026-08-25 with
prisma8.0.0-rc.9.compute/deploy-on-push.mdx. A guide that takes a locally deployed Composer app (the full-stack tutorial's end state) to push-to-deploy: link,git connect, add the workflow, then production on default-branch pushes, an isolated preview stage per branch, and teardown on branch delete. Added to the Compute nav under Integrations.compute/github.mdx. Now describes what the connection does (credentials and branch lifecycle) and makes the two entry paths explicit: the Console opens a PR that adds the workflow, the CLI registers the connection only. Corrects the claim thatgit connect --no-interactiveprints the install URL; it fails withCLI.INTERACTION_REQUIRED.cli/git.mdx,compute/branching.mdx,compute/deployments.mdx,compute/index.mdx,composer/deploying.mdx(CI section now points GitHub users at the action first), and the full-stack tutorial's "Deploy on push" next step.Open questions
prisma composercommands and fail withCLI.UNKNOWN_COMMANDagainstprisma8.0.0-rc.8 or later. The fix is Fix the action against the current prisma CLI (top-level deploy, 8.0.0-rc.9) cloud-deploy-action#12 (draft as of writing). The guide targets the fixed behavior and carries an inline failure note; once the fixed release is out, the note can name the minimum version.mode: destroyteardown job. The unified CLI has nodestroycommand, so that job fails, and the platform's branch automation already tears previews down. The guide shows a push-only workflow. Shouldmode: destroybe documented once it works, or should teardown stay platform-side?compute/getting-started.mdxstill describes platform builds with framework detection. Left untouched; it may describe the non-Composer, compute-config path. Worth deciding whether that flow still exists.Validation
skipped-no-credential) for unconnected repos and forks.pnpm lint:links,pnpm lint:agent-ready, and cspell pass on the touched files.url:frontmatter and follows the section's frontmatter and code-fence conventions; prose follows.claude/skills/docs-writer.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation