Skip to content

Commit 1bb1433

Browse files
authored
Add GitHub Actions workflow for Pages Preview
1 parent 64ac00d commit 1bb1433

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

.github/workflows/preview.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
- name: Pages Preview
2+
# You may pin to the exact commit or the version.
3+
# uses: EndBug/pages-preview@3e2aef8b39eb77522c278172e94c8628b2b58bcc
4+
uses: EndBug/pages-preview@v1.1.2
5+
with:
6+
# The directory in which the website has been built, in the a/b/c format
7+
build_dir:
8+
# The GitHub Pages base URL of the preview repo (e.g. https://octocat.github.io/preview)
9+
preview_base_url:
10+
# The repository to push previews to, in the Owner/Name format
11+
preview_repo:
12+
# The token to access the preview repo
13+
preview_token:
14+
# The name of the environment to use for the deployment
15+
deployment_env: # optional, default is preview
16+
# Whether to use the deployments API
17+
deployments: # optional, default is true
18+
# The name of the author of the resulting commit
19+
git_author_name: # optional, default is ${{ github.actor }}
20+
# The email of the author of the resulting commit
21+
git_author_email: # optional, default is ${{ github.actor }}@users.noreply.github.com
22+
# The committer of the resulting commit
23+
git_committer_name: # optional
24+
# The email of the committer of the resulting commit
25+
git_committer_email: # optional
26+
# Whether to comment on PRs
27+
pr_comment: # optional, default is true
28+
# The name of the branch that hosts the previews
29+
preview_branch: # optional, default is gh-pages
30+
# 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'
31+
preview_workflow_file_name: # optional, default is preview.yml
32+

0 commit comments

Comments
 (0)