https://github.com/prisma/create-prisma-postgres-database-action
https://github.com/prisma/create-prisma-postgres-database-action
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prisma/create-prisma-postgres-database-action
- Owner: prisma
- License: apache-2.0
- Created: 2025-07-17T13:38:37.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-23T08:03:26.000Z (11 months ago)
- Last Synced: 2025-08-28T13:46:45.139Z (10 months ago)
- Language: JavaScript
- Size: 264 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create Prisma Postgres Database Action
A GitHub Action to create Prisma Postgres databases in your CI/CD workflows.
## Usage
### Basic Usage
```yaml
- name: Create Database
id: create
uses: prisma/create-prisma-postgres-database-action@v1
with:
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
- name: Use Database
env:
DATABASE_URL: ${{ steps.create.outputs.database_url }}
run: |
echo "Database ready: ${{ steps.create.outputs.database_name }}"
# Use the DATABASE_URL in your application
```
### With Custom Database Name
```yaml
- name: Create Database
uses: prisma/create-prisma-postgres-database-action@v1
with:
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
database_name: "my-test-db"
```
### Complete Example to Provision Prisma Postgres when PR is opened and delete when PR is closed
```yaml
name: Prisma Postgres Database Lifecycle
on:
pull_request:
types: [opened, reopened, synchronize, closed]
jobs:
create-database:
name: Create Database
if: github.event.action != 'closed'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Create Database
id: create
uses: prisma/create-prisma-postgres-database-action@v1
with:
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
database_name: "pr-${{ github.event.pull_request.number }}"
- name: Verify database creation
run: |
echo "✅ Database created successfully!"
echo "Database ID: ${{ steps.create.outputs.database_id }}"
echo "Database Name: ${{ steps.create.outputs.database_name }}"
echo "Database URL is available in steps.create.outputs.database_url"
cleanup-database:
name: Cleanup Database
if: always() && github.event.action == 'closed'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Delete Database
id: delete
uses: prisma/delete-prisma-postgres-database-action@v1
with:
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
database_name: "pr-${{ github.event.pull_request.number }}"
- name: Verify database deletion
run: |
if [ "${{ steps.delete.outputs.deleted }}" == "true" ]; then
echo "✅ Database ${{ steps.delete.outputs.database_name }} was deleted"
else
echo "ℹ️ No database found to delete"
fi
```
## Inputs
| Input | Description | Required | Default |
| --------------- | ----------------------------- | -------- | -------------- |
| `service_token` | Prisma Postgres service token | ✅ | |
| `project_id` | Prisma project ID | ✅ | |
| `database_name` | Database name | ❌ | Auto-generated |
| `region` | Database region | ❌ | `us-east-1` |
## Outputs
| Output | Description |
| --------------- | --------------------------------------- |
| `database_id` | The ID of the created/existing database |
| `database_name` | The name of the database |
| `database_url` | The DATABASE_URL for the database |
## Setup
### 1. Get Prisma Postgres Credentials
1. Sign up for [Prisma Postgres](https://www.prisma.io/postgres)
2. Generate a service token
### 2. Create a Dedicated Project for CI
To avoid conflicts with your development databases, create a dedicated project specifically for CI workflows. Use the following curl command to create a new Prisma Postgres project:
```bash
curl -X POST https://api.prisma.io/v1/projects \
-H "Authorization: Bearer $PRISMA_POSTGRES_SERVICE_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"region\": \"us-east-1\", \"name\": \"$PROJECT_NAME\"}"
```
Note the project ID from the response.
### 3. Add Repository Secrets
Go to your repository settings → Secrets and variables → Actions, and add:
- `PRISMA_POSTGRES_SERVICE_TOKEN`: Your Prisma Postgres service token
- `PRISMA_PROJECT_ID`: Your Prisma project ID
### 4. Use in Your Workflow
Add the action to your workflow as shown in the examples above.
## Database Naming
**Auto-generated names:**
- PR context: `pr_{pr_number}_{branch_name}`
- Other contexts: `test_{run_number}`
## Using with Different Tools
This action only provisions the database and provides a connection string. You can use it with any database tool:
### With Prisma
```yaml
- name: Setup with Prisma
env:
DATABASE_URL: ${{ steps.provision.outputs.database_url }}
run: |
npx prisma generate
npx prisma db push
```
## Related Actions
- [Delete Prisma Postgres Database Action](https://github.com/prisma/delete-prisma-postgres-database-action) - Delete Prisma Postgres database
## Support
For issues and questions:
- [GitHub Issues](https://github.com/prisma/create-prisma-postgres-database-action/issues)
- [Prisma Postgres Documentation](https://www.prisma.io/docs/postgres)
## License
Apache License - see [LICENSE](LICENSE) file for details.