4.6 KiB
About
A GitHub Action to deploy to GitHub Pages
If you are interested, check out my other :octocat: GitHub Actions!
Usage
Below is a simple snippet to deploy to GitHub Pages. A test workflow is also available for this repository and deploys to GitHub pages at https://crazy-max.github.io/ghaction-github-pages/.
name: website
on: push
jobs:
publish:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v1
-
name: Build
run: |
mkdir public
cat > public/index.html <<EOL
<!doctype html>
<html>
<head>
<title>GitHub Pages deployed!</title>
</head>
<body>
<p>GitHub Pages with <strong>${{ github.sha }}</strong> commit ID has been deployed through <a href="https://github.com/marketplace/actions/github-pages">GitHub Pages action</a> successfully.</p>
</body>
</html>
EOL
-
name: Deploy
if: success()
uses: crazy-max/ghaction-github-pages@v1
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Customizing
inputs
Following inputs can be used as step.with keys
| Name | Type | Description |
|---|---|---|
repo |
String | GitHub repository where assets will be deployed (default current) |
target_branch |
String | Git branch where assets will be deployed (default gh-pages) |
keep_history |
Bool | Create incremental commit instead of doing push force (default false) |
allow_empty_commit |
Bool | Allow an empty commit to be created (default true) |
build_dir |
String | Build directory to deploy (required) |
committer_name |
String | Commit author's name (default GITHUB_ACTOR or github-actions) |
committer_email |
String | Commit author's email (default <committer_name>@users.noreply.github.com) |
commit_message |
String | Commit message (default Deploy to GitHub pages) |
fqdn |
String | Write the given domain name to the CNAME file |
environment variables
Following environment variables can be used as step.env keys
| Name | Description |
|---|---|
GITHUB_TOKEN |
GITHUB_TOKEN as provided by secrets |
GITHUB_PAT |
Use a Personal Access Token if you want to deploy to another repo |
How can I help?
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also support this project by becoming a sponsor on GitHub 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀
Thanks again for your support, it is much appreciated! 🙏
License
MIT. See LICENSE for more details.