This file contains 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
| name: Create/Delete Branch for Pull Request | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - closed | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| jobs: | |
| setup: | |
| name: Setup | |
| outputs: | |
| branch: ${{ steps.branch_name.outputs.current_branch }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get branch name | |
| id: branch_name | |
| uses: tj-actions/branch-names@v8 | |
| create_neon_branch: | |
| name: Create Neon Branch | |
| outputs: | |
| db_url: ${{ steps.create_neon_branch_encode.outputs.db_url }} | |
| db_url_with_pooler: ${{ steps.create_neon_branch_encode.outputs.db_url_with_pooler }} | |
| needs: setup | |
| if: | | |
| github.event_name == 'pull_request' && ( | |
| github.event.action == 'synchronize' | |
| || github.event.action == 'opened' | |
| || github.event.action == 'reopened') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Create Neon Branch | |
| id: create_neon_branch | |
| uses: neondatabase/create-branch-action@v5 | |
| with: | |
| project_id: ${{ vars.NEON_PROJECT_ID }} | |
| branch_name: preview/pr-${{ github.event.number }}-${{ needs.setup.outputs.branch }} | |
| api_key: ${{ secrets.NEON_API_KEY }} | |
| # The step above creates a new Neon branch. | |
| # You may want to do something with the new branch, such as run migrations, run tests | |
| # on it, or send the connection details to a hosting platform environment. | |
| # The branch DATABASE_URL is available to you via: | |
| # "${{ steps.create_neon_branch.outputs.db_url_with_pooler }}". | |
| # It's important you don't log the DATABASE_URL as output as it contains a username and | |
| # password for your database. | |
| # For example, you can uncomment the lines below to run a database migration command: | |
| # - name: Run Migrations | |
| # run: npm run db:migrate | |
| # env: | |
| # # to use pooled connection | |
| # DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url_with_pooler }}" | |
| # # OR to use unpooled connection | |
| # # DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url }}" | |
| # Following the step above, which runs database migrations, you may want to check | |
| # for schema changes in your database. We recommend using the following action to | |
| # post a comment to your pull request with the schema diff. For this action to work, | |
| # you also need to give permissions to the workflow job to be able to post comments | |
| # and read your repository contents. Add the following permissions to the workflow job: | |
| # | |
| # permissions: | |
| # contents: read | |
| # pull-requests: write | |
| # | |
| # You can also check out https://github.com/neondatabase/schema-diff-action for more | |
| # information on how to use the schema diff action. | |
| # You can uncomment the lines below to enable the schema diff action. | |
| # - name: Post Schema Diff Comment to PR | |
| # uses: neondatabase/schema-diff-action@v1 | |
| # with: | |
| # project_id: ${{ vars.NEON_PROJECT_ID }} | |
| # compare_branch: preview/pr-${{ github.event.number }}-${{ needs.setup.outputs.branch }} | |
| # api_key: ${{ secrets.NEON_API_KEY }} | |
| delete_neon_branch: | |
| name: Delete Neon Branch | |
| needs: setup | |
| if: github.event_name == 'pull_request' && github.event.action == 'closed' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Delete Neon Branch | |
| uses: neondatabase/delete-branch-action@v3 | |
| with: | |
| project_id: ${{ vars.NEON_PROJECT_ID }} | |
| branch: preview/pr-${{ github.event.number }}-${{ needs.setup.outputs.branch }} | |
| api_key: ${{ secrets.NEON_API_KEY }} |