Vercel Preview Github Action

[jgoux]

Hello all 👋,

I'm a software engineer at Snaplet. We are working hard to enable developers across the world to don't have to worry about seeding or replicating their production databases into their dev or preview environments. 🙇‍♂️

Vercel is an integral part of this story, this week I investigated how we can integrate Snaplet with Vercel and I came up with this new GitHub Action: https://github.com/marketplace/actions/vercel-preview-deployments

My goal was to take control of when a deployment happens so I can orchestrate external resources creation before deploying a Vercel preview. It could be done with vercel deploy --prebuilt but the downside of using it is that you don't have the sweet feedback from the Vercel GitHub App anymore.

What I did instead is leveraging deploy hooks so it's still possible to benefit from the Vercel GitHub App, while also being able to deploy when I decide, the best of both worlds! 😄

The action also has a delete option to clean up everything that could be produced on Vercel (mainly new environment variables), so it fits really well with a Pull Request lifecycle.

Don't hesitate to ping me if you want to know more, or if you want to try Snaplet as well (we are on Discord). 🐱

[david0673]

this is awesome! any suggested workarounds for the limit of 5 deploy hooks?

Separately, if I'm not mistaken, the action has moved to
https://github.com/snaplet/vercel-action

[jgoux]

Was the issue with Vercel's GitHub PR checks getting out of sync as a result of these changes resolved

I'm not aware of this issue. @ofhouse did all the work, maybe he knows?

[ofhouse]

Was the issue with Vercel's GitHub PR checks getting out of sync as a result of these changes resolved?

Not resolved yet, was more important for us to get the update out first, so that you are no longer blocked by the Deploy Hook limit ✌️

That the PR check got out of sync is a result that we now using another API endpoint for that internally.
It's on our radar and we should be able to fix it on our side without any update needed.

Will update here (and through our customer support) once we have it resolved, cheers 🍻

[ofhouse]

Finally found some time to investigate further.
Problem is that I thought GITHUB_SHA would refer to the commit that is part of a PR (See this discussion: https://github.com/orgs/community/discussions/26325) 🙈

So the check is added from our side, but unfortunately to a ghost commit that never shows up in the PR.
Made a PR here to fix it: snaplet/vercel-action#10

[jgoux]

Thanks @ofhouse for your contribution, I released it under v3/v3.0.1 👍

[ofhouse]

Great @jgoux, thanks for your super fast response, really appreciate 👍