Deploy Button
Add a Deploy with Prisma button that copies a public Composer repository and starts a Composer-managed deployment.
The Deploy Button starts a guided deployment from a compatible public GitHub repository. Prisma copies the source into a new repository under the chosen GitHub account or organization and adds a managed GitHub Actions workflow. That workflow runs Composer, which creates the Prisma project and provisions the resources declared by the repository.
Add the button to a README, blog post, or website so other users can deploy their own copy.
Create your button
Enter your repository URL and copy the generated snippet:
Enter your repository's GitHub URL to generate the button. The repository must be public and contain a Composer config and module at its root.
Repository requirements
Before publishing the button, make sure the source repository:
- is a public GitHub repository;
- has a Composer config and module at its root;
- default-exports a Composer module whose name is a string literal;
- has a root
package.jsonwith abuildscript, or uses Nx build targets; - has one supported root lockfile:
bun.lock,package-lock.json,pnpm-lock.yaml, oryarn.lock; and - declares every required service and resource in its Composer module.
The repository can contain up to 100 files and 25 MB in total, with no file larger than 5 MB. Symlinks, Git submodules, and custom GitHub Actions workflows are not supported.
See Getting started with Composer to prepare a repository.
URL options
A Deploy Button links to:
https://console.prisma.io/new/clone?repository-url=<your repository URL>| Parameter | Required | Description |
|---|---|---|
repository-url | Yes | Public GitHub repository in the form https://github.com/owner/repo. URL-encode it when composing the link. |
project-name | No | Prefills the destination repository name. The user can change it. |
utm_source | No | Records where the deployment link was published, such as github-readme. |
Deploy Button URLs do not accept environment variables. The first deployment must not depend on secrets that Composer cannot provide. Add any other variables to the project after deployment, then redeploy.
How it works
- The user chooses a workspace, a GitHub account or organization, a repository name, and its visibility.
- Prisma copies the source into a new repository under that account or organization and adds the deployment workflow.
- The workflow runs Composer, which creates the Prisma project, provisions its resources, and deploys the app. Future pushes run the workflow again.