Skip to content

Commit

Permalink
Update version (showcase latest while encouraging using fixed version)
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadorequest committed Jan 9, 2023
1 parent 435b4f1 commit 1271dc3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
wait-for-vercel-deployment:
runs-on: ubuntu-22.04
steps:
- uses: UnlyEd/github-action-await-vercel@v1.2.14
- uses: UnlyEd/github-action-await-vercel@latest # TODO best practices recommend to use a fixed version instead of @latest for production usage (i.e: @v1.2.32)
id: await-vercel
env:
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
Expand Down Expand Up @@ -100,7 +100,7 @@ In the below example, we show you how to:

1. **Step 1**: Forward `VERCEL_DEPLOYMENT_URL` as an ENV variable, using ` >> $GITHUB_ENV"` which stores the value into the GitHub Actions env vars.
Of course, you might do it differently. It doesn't really matter as long as `VERCEL_DEPLOYMENT_URL` is set.
1. **Step 2**: Then, we use the `UnlyEd/github-action-await-vercel@v1.2.14` GitHub Action, which waits for the deployment url to be ready.
1. **Step 2**: Then, we use the `UnlyEd/github-action-await-vercel@latest` GitHub Action, which waits for the deployment url to be ready.
1. **Step 3**: Finally, we show an example on how to read the deployment's information returned by the Vercel API (which have been forwarded).

```yaml
Expand All @@ -117,7 +117,7 @@ jobs:
- name: Retrieve deployment URL (example on how to set an ENV var)
run: "echo VERCEL_DEPLOYMENT_URL=nextjs-bzyss249z.vercel.app >> $GITHUB_ENV"
- uses: UnlyEd/github-action-await-vercel@v1.2.14
- uses: UnlyEd/github-action-await-vercel@latest # TODO best practices recommend to use a fixed version instead of @latest for production usage (i.e: @v1.2.32)
id: await-vercel
env:
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
Expand Down

0 comments on commit 1271dc3

Please sign in to comment.