{"repo":"EndBug/pages-preview","free":true,"listed":false,"github":"https://github.com/EndBug/pages-preview","clone":"git clone https://github.com/EndBug/pages-preview.git","description":":octocat: A GitHub Action that creates a GitHub Pages preview for PRs and branches","language":"Shell","stars":18,"topics":["ci","cicd","deployment","github-actions","github-pages","preview"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Pages Preview Table of contents - What does it do? - Setup - Inputs What does it do? A lot of third-party services allow you create preview deployments of branches and pull requests, so that you can use them to review and test your changes. This action allows you to do the same thing, but directly with GitHub Pages. In particular, this action deploys your website to a different repo, which will contain the previews of all the repos you choose to use this on. If you're interested in the logic behind this action, you can check out the flow diagram. Setup Preview repo Using my template 1. Go to this template and generate your repo from there: click \"Use this template\", fill in name and description, check that \"Include all branches\" is ticked, and create the repo. It doesn't matter whether you create it as public or private, but remember that the Pages website will always be public. 2. Go into your repo settings, in the Pages tab (Repo settings Pages) and set \"GitHub Actions\" as the source. Manually 1. Create a new repo that will host your previews. This repo will be used for the previews from all your repositories, so you'll need to set this up only once. 2. Make sure that this repo has two branches: main and gh-pages (you can also choose different names). - main should be your default branch, and it will only hold a workflow (and any additional files you want to add, liKE a README, a license, etc.). - gh-pages will be the branch that will contain the actual previews, and it sho","default_branch":null,"files":null,"tree":[],"storefront":"/r/EndBug","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/EndBug/pages-preview/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."}