Updating the deploy-preview.yml #12
Conversation
Moving to use $GITHUB_ENV which should work for the migrate and deploy steps Dropping some of the top level env variables. Moved NEON_PROJECT_ID from secret to var
| GH_TOKEN: ${{ secrets.GH_TOKEN }} # Required for commenting on pull requests for private repos | ||
| NEON_API_KEY: ${{ secrets.NEON_API_KEY }} # You can generate a an API key in your account settings | ||
| NEON_PROJECT_ID: ${{ secrets.NEON_PROJECT_ID }} # You can find this in your project settings | ||
| NEON_PROJECT_ID: ${{ var.NEON_PROJECT_ID }} # You can find this in your Neon project settings |
There was a problem hiding this comment.
This will require you moving the NEON_PROJECT_ID from secrets over to vars but it's not a protected secret so I think that's fine.
There was a problem hiding this comment.
If we move NEON_PROJECT_ID to vars it no longer needs to be listed up here. However I think it's good to have here so we can explain where it came from.
There was a problem hiding this comment.
Yea I'm a fan of listing variables at the top of the workflow
| @@ -21,46 +19,40 @@ jobs: | |||
| - uses: pnpm/action-setup@v2 | |||
| with: | |||
| version: 8 | |||
| - name: Use Node.js 18 | |||
| uses: actions/setup-node@v4 | |||
| - uses: actions/setup-node@v4 | |||
There was a problem hiding this comment.
Similar to code comments, I only like them when they are stating a reason that's not obvious. Otherwise they're superfluous.
| run: | | ||
| touch .env | ||
| username: ${{ secrets.NEON_DATABASE_USERNAME }} # change to your Neon database username / role | ||
| api_key: ${{ secrets.NEON_API_KEY }} # Generate a an API key in your Neon account settings |
There was a problem hiding this comment.
Moved this away from the env header because otherwise all the previous steps have access to this secret. Ideally we only expose it to the actions who need it.
|
|
||
| echo DATABASE_URL=${{ steps.create-branch.outputs.db_url_with_pooler }}?sslmode=require >> .env | ||
| - run: | | ||
| echo "DATABASE_URL=${{ steps.create-branch.outputs.db_url_with_pooler }}?sslmode=require" >> "$GITHUB_ENV" |
There was a problem hiding this comment.
This feels cleaner to me compared to creating the .env file. And it should work the same way... testing needed.
| uses: superfly/[email protected] | ||
| with: | ||
| secrets: DATABASE_URL=${{ steps.create-branch.outputs.db_url }}?sslmode=require | ||
| secrets: DATABASE_URL=$DATABASE_URL |
There was a problem hiding this comment.
This should be picking up the env variable created with the >> $GITHUB_ENV step.
|
|
||
| - name: Comment on Pull Request | ||
| uses: thollander/actions-comment-pull-request@v2 | ||
| with: | ||
| # GITHUB_TOKEN: ${{ env.GH_TOKEN }} # Required for commenting on pull requests for private repos | ||
| message: | | ||
| Fly Preview URL :balloon: : ${{ steps.deploy.outputs.url }} | ||
| Neon branch :elephant: : https://console.neon.tech/app/projects/${{ secrets.NEON_PROJECT_ID }}/branches/${{ steps.create-branch.outputs.branch_id }} | ||
| Neon branch :elephant: : https://console.neon.tech/app/projects/${{ env.NEON_PROJECT_ID }}/branches/${{ steps.create-branch.outputs.branch_id }} |
There was a problem hiding this comment.
Pulls from the env variable at the top of the file instead of the secret directly.
|
Looks good to me! |
Co-authored-by: Bryan Clark <[email protected]>
Use the var.NEON_PROJECT_ID to match
Truncate step names Move env variables for this one down to the steps that require them. We've explained in other files where they are needed.
Co-authored-by: Bryan Clark <[email protected]>
Moving to use $GITHUB_ENV which should work for the migrate and deploy steps
Dropping some of the top level env variables.
Moved NEON_PROJECT_ID from secret to var