endbug/Pages Preview
Deploy GitHub Pages previews for your branches and PRs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Mar 17, 2026
- License
- MIT
Pinned Snippet
uses: endbug/pages-preview@3e2aef8b39eb77522c278172e94c8628b2b58bcc # v1.1.2tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| build_dir | The directory in which the website has been built, in the a/b/c format | yes | — |
| preview_base_url | The GitHub Pages base URL of the preview repo (e.g. https://octocat.github.io/preview) | yes | — |
| preview_repo | The repository to push previews to, in the Owner/Name format | yes | — |
| preview_token | The token to access the preview repo | yes | — |
| deployment_env | The name of the environment to use for the deployment | no | preview |
| deployments | Whether to use the deployments API | no | true |
| git_author_name | The name of the author of the resulting commit | no | ${{ github.actor }} |
| git_author_email | The email of the author of the resulting commit | no | ${{ github.actor }}@users.noreply.github.com |
| git_committer_name | The committer of the resulting commit | no | — |
| git_committer_email | The email of the committer of the resulting commit | no | — |
| pr_comment | Whether to comment on PRs | no | true |
| preview_branch | The name of the branch that hosts the previews | no | gh-pages |
| preview_workflow_file_name | The name of the workflow file that contains the comment workflow in the preview repo. If you use my template, the name is already 'preview.yml' | no | preview.yml |
Outputs
no outputs