Skip to content

Commit 7adb0c4

Browse files
nurul3101nurul3101
committed
(feat) Create Prisma Postgres Database GitHub Action
0 parents  commit 7adb0c4

File tree

5 files changed

+548
-0
lines changed

5 files changed

+548
-0
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Create Prisma Postgres Database Action
2+
3+
A GitHub Action to create Prisma Postgres databases in your CI/CD workflows.
4+
5+
## Usage
6+
7+
### Basic Usage
8+
9+
```yaml
10+
- name: Create Database
11+
id: create
12+
uses: prisma/create-prisma-postgres-database-action@v1
13+
with:
14+
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
15+
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
16+
17+
- name: Use Database
18+
env:
19+
DATABASE_URL: ${{ steps.create.outputs.database_url }}
20+
run: |
21+
echo "Database ready: ${{ steps.create.outputs.database_name }}"
22+
# Use the DATABASE_URL in your application
23+
```
24+
25+
### With Custom Database Name
26+
27+
```yaml
28+
- name: Create Database
29+
uses: prisma/create-prisma-postgres-database-action@v1
30+
with:
31+
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
32+
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
33+
database_name: "my-test-db"
34+
```
35+
36+
### Complete Example for Pull Requests
37+
38+
```yaml
39+
name: PR Database Testing
40+
on:
41+
pull_request:
42+
types: [opened, reopened, synchronize]
43+
44+
jobs:
45+
test:
46+
runs-on: ubuntu-latest
47+
steps:
48+
- uses: actions/checkout@v4
49+
50+
- name: Create Database
51+
id: create
52+
uses: prisma/create-prisma-postgres-database-action@v1
53+
with:
54+
service_token: ${{ secrets.PRISMA_POSTGRES_SERVICE_TOKEN }}
55+
project_id: ${{ secrets.PRISMA_PROJECT_ID }}
56+
57+
- name: Setup Database Schema
58+
env:
59+
DATABASE_URL: ${{ steps.create.outputs.database_url }}
60+
run: |
61+
npx prisma generate
62+
npx prisma db push
63+
64+
- name: Run Tests
65+
env:
66+
DATABASE_URL: ${{ steps.create.outputs.database_url }}
67+
run: npm test
68+
```
69+
70+
## Inputs
71+
72+
| Input | Description | Required | Default |
73+
| --------------- | ----------------------------- | -------- | -------------- |
74+
| `service_token` | Prisma Postgres service token | ✅ | |
75+
| `project_id` | Prisma project ID | ✅ | |
76+
| `database_name` | Database name | ❌ | Auto-generated |
77+
| `region` | Database region | ❌ | `us-east-1` |
78+
79+
## Outputs
80+
81+
| Output | Description |
82+
| --------------- | --------------------------------------- |
83+
| `database_id` | The ID of the created/existing database |
84+
| `database_name` | The name of the database |
85+
| `database_url` | The DATABASE_URL for the database |
86+
87+
## Setup
88+
89+
### 1. Get Prisma Postgres Credentials
90+
91+
1. Sign up for [Prisma Postgres](https://www.prisma.io/postgres)
92+
2. Generate a service token
93+
94+
### 2. Create a Dedicated Project for CI
95+
96+
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:
97+
98+
```bash
99+
curl -X POST https://api.prisma.io/v1/projects \
100+
-H "Authorization: Bearer $PRISMA_POSTGRES_SERVICE_TOKEN" \
101+
-H "Content-Type: application/json" \
102+
-d "{\"region\": \"us-east-1\", \"name\": \"$PROJECT_NAME\"}"
103+
```
104+
105+
Note the project ID from the response.
106+
107+
### 3. Add Repository Secrets
108+
109+
Go to your repository settings → Secrets and variables → Actions, and add:
110+
111+
- `PRISMA_POSTGRES_SERVICE_TOKEN`: Your Prisma Postgres service token
112+
- `PRISMA_PROJECT_ID`: Your Prisma project ID
113+
114+
### 4. Use in Your Workflow
115+
116+
Add the action to your workflow as shown in the examples above.
117+
118+
## Database Naming
119+
120+
**Auto-generated names:**
121+
122+
- PR context: `pr_{pr_number}_{branch_name}`
123+
- Other contexts: `test_{run_number}`
124+
125+
## Using with Different Tools
126+
127+
This action only provisions the database and provides a connection string. You can use it with any database tool:
128+
129+
### With Prisma
130+
131+
```yaml
132+
- name: Setup with Prisma
133+
env:
134+
DATABASE_URL: ${{ steps.provision.outputs.database_url }}
135+
run: |
136+
npx prisma generate
137+
npx prisma db push
138+
```
139+
140+
## Related Actions
141+
142+
- [Delete Prisma Postgres Database Action](https://github.com/prisma/delete-prisma-postgres-database-action) - Delete Prisma Postgres database
143+
144+
## Support
145+
146+
For issues and questions:
147+
148+
- [GitHub Issues](https://github.com/prisma/create-prisma-postgres-database-action/issues)
149+
- [Prisma Postgres Documentation](https://www.prisma.io/docs/postgres)
150+
151+
## License
152+
153+
Apache License - see [LICENSE](LICENSE) file for details.

‎action.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 'Create Prisma Postgres Database'
2+
description: 'Creates a Prisma Postgres database and returns connection string'
3+
author: 'Prisma'
4+
branding:
5+
icon: 'database'
6+
color: 'blue'
7+
8+
inputs:
9+
service_token:
10+
description: 'Prisma Postgres service token'
11+
required: true
12+
project_id:
13+
description: 'Prisma project ID'
14+
required: true
15+
database_name:
16+
description: 'Database name'
17+
required: false
18+
region:
19+
description: 'Database region'
20+
required: false
21+
default: 'us-east-1'
22+
23+
outputs:
24+
database_id:
25+
description: 'The ID of the created/existing database'
26+
database_name:
27+
description: 'The name of the database'
28+
database_url:
29+
description: 'The DATABASE_URL for the database'
30+
31+
runs:
32+
using: 'node20'
33+
main: 'index.js'

0 commit comments

Comments
 (0)