neondatabase/Neon Create Branch GitHub Action
Creates a new branch in a Neon project, if the branch already exists it will return the existing branch.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api_key | The Neon API key | yes | — |
| api_host | The Neon API Host | — | https://console.neon.tech/api/v2 |
| branch_name | The name of the branch to create | — | — |
| project_id | The Neon project ID | yes | — |
| parent_branch | The parent branch to create the new branch from | — | — |
| prisma | Whether to use prisma or not | — | false |
| database | The database name | — | neondb |
| role | The role of the user | — | neondb_owner |
| branch_type | The type of branch to create, 'default' or 'schema-only' | — | default |
| ssl | The SSL mode for the connection string. Supported values are: 'require', 'verify-ca', 'verify-full', 'omit'. | — | require |
| suspend_timeout | Duration of inactivity in seconds after the compute endpoint is suspended | — | 0 |
| expires_at | Date and time when the branch should be deleted. | — | "" |
| masking_rules | A JSON string representing an array of data masking rules to be applied to the branch. https://api-docs.neon.tech/reference/updatemaskingrules | — | — |
| get_auth_url | Whether to get the neon auth url for the branch. If neon auth is not enabled for this branch, return undefined. | — | false |
| get_data_api_url | Whether to get the Neon Data API url for the branch. If Data API is not enabled for this branch, return undefined. | — | false |
Outputs
| name | description |
|---|---|
| db_url | The database connection string |
| db_url_pooled | The database connection string with connection pooling |
| db_host | The database host |
| db_host_pooled | The database host with connection pooling |
| password | The database password |
| branch_id | The ID of the branch |
| created | Whether the branch was created or reused |
| auth_url | The Neon Auth URL for the branch. Undefined if neon auth is not enabled for the branch. |
| data_api_url | The Neon Data API URL for the branch. Undefined if Data API is not enabled for the branch. |