Repository navigation
docs: semi-technical copy for storage / delivery messaging #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
5ca80da
876f602
4bf0a11
c745ee8
4ff2c7a
f53e843
7a678ce
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| 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 | ||
| permissions: | ||
| contents: read | ||
| outputs: | ||
| db_url: ${{ steps.create_neon_branch.outputs.db_url }} | ||
| db_url_pooled: ${{ steps.create_neon_branch.outputs.db_url_pooled }} | ||
| 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: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Get branch expiration date as an env variable (2 weeks from now) | ||
| id: get_expiration_date | ||
| run: echo "EXPIRES_AT=$(date -u --date '+14 days' +'%Y-%m-%dT%H:%M:%SZ')" >> "$GITHUB_ENV" | ||
|
|
||
| - name: Create Neon Branch | ||
| id: create_neon_branch | ||
| uses: neondatabase/create-branch-action@v6 | ||
| with: | ||
| project_id: ${{ vars.NEON_PROJECT_ID }} | ||
| branch_name: preview/pr-${{ github.event.number }}-${{ needs.setup.outputs.branch }} | ||
| api_key: ${{ secrets.NEON_API_KEY }} | ||
| expires_at: ${{ env.EXPIRES_AT }} | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 22 | ||
| cache: yarn | ||
|
|
||
| - name: Enable Corepack (Yarn from packageManager) | ||
| run: corepack enable | ||
|
|
||
| - name: Install dependencies | ||
| run: yarn install --immutable | ||
|
|
||
| # 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_pooled }}". | ||
| # It's important you don't log the DATABASE_URL as output as it contains a username and | ||
| # password for your database. | ||
| - name: Run Migrations | ||
| run: yarn db:push | ||
| env: | ||
| # to use pooled connection | ||
| #DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url_pooled }}" | ||
| # OR to use unpooled connection | ||
| DATABASE_URL: "${{ steps.create_neon_branch.outputs.db_url }}" | ||
|
|
||
|
Comment on lines
+39
to
+82
|
||
| # 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 }} | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is described as documentation/copy updates, but it also adds a new GitHub Actions workflow that creates/deletes Neon branches and runs migrations. Please update the PR description/title to include this operational change (or split the workflow into a separate PR) so reviewers can assess the workflow/security implications explicitly.