{"repo":"rossjrw/pr-preview-action","free":true,"listed":false,"github":"https://github.com/rossjrw/pr-preview-action","clone":"git clone https://github.com/rossjrw/pr-preview-action.git","description":"GitHub Action that deploys a pull request preview to GitHub Pages, similar to Vercel and Netlify, and cleans up after itself.","language":"Shell","stars":435,"topics":["github-pages","github-actions","workflow","deployment","gh-pages","actions","action","pr-preview","preview","pull-requests"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Deploy PR Preview action GitHub Action that deploys previews of pull requests to GitHub Pages. Works on any repository with a GitHub Pages site. Features: - Creates and deploys previews of pull requests to your GitHub Pages site - Leaves a comment on the pull request with a link to the preview so that you and your team can collaborate on new features faster - Updates the deployment and the comment whenever new commits are pushed to the pull request - Includes a QR code in the preview comment for easy mobile access - Cleans up after itself — removes deployed previews when the pull request is closed - Can be configured to override any of these behaviours Preview URLs look like this: https://[owner].github.io/[repo]/pr-preview/pr-[number]/ Pictured: https://github.com/rossjrw/pr-preview-action/pull/1 This Action does not currently support deploying previews for PRs from forks, but will do so in the upcoming v2. Setup A GitHub Actions workflow is required to use this Action. You just need to do two things to set up your repository to support previews, both in the repository settings: 1. Deploy Pages from branch Ensure that your repository is configured to have its GitHub Pages site deployed from a branch, by setting the source for the deployment under Settings Pages of your repository to Deploy from branch : Pictured: Repository Pages settings at /settings/page [!IMPORTANT] The other option (called \"GitHub Actions\") has a misleading name and does not work with this action. ","default_branch":null,"files":null,"tree":[],"storefront":"/r/rossjrw","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rossjrw/pr-preview-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}