CI: allow preview deployment of web pull request
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.2k
- Forks
- 726
- Avg merge
- 11d 11h
- Merged PRs (30d)
- 7
Description
To allow quick feedback from others, it would be really helpful to have a preview deployment of a pull request so others do not need to build it on their local environment.
An option would be Vercel GitHub Actions: it creates and deploys an instance upon a new PR (can limit to web PRs only), it also allows to inspect the build logs for failed builds (example). Vercel's preview URLs look like: <project-name>-git-<branch-name>-<scope-slug>.vercel.app
Vercel can deploy separate sites like main, rules, explorer.
A flexible and lightweight alternative is Deploy to Vercel GitHub Action which allows for PR previews using Vercel
Another alternative that doesn't use Vercel is Deploy PR Preview GitHub Actions. The preview URL will be: https://[owner].github.io/[repo]/pr-preview/pr-[number]/ (⟵ could lead to defacement)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are identified. Start by locating the repository's GitHub Actions and web deployment configuration, then evaluate the proposed Vercel or alternative PR-preview actions. Done means web pull requests produce usable preview URLs and failed builds expose logs, with the separate web sites and security implications addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, devops, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100