🚀 GitHub action for building a project and deploying it to GitHub pages.
As of version 3 release on the original JamesIves repo, this fork is no longer needed.
This GitHub action will handle the building and deploy process of your project to GitHub Pages. It can be configured to upload your production-ready code into any branch you'd like, including gh-pages and docs. This action is built on Python, which means that you can call any optional build scripts your project requires prior to deploying.
You can include the action in your workflow to trigger on any event that GitHub actions supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the actions/checkout step before this workflow runs in order for the deployment to work.
You can view an example of this below.
name: Build and Deploy
on:
push:
branches:
- master
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master
- name: Build and Deploy
uses: JacksonMaxfield/github-pages-deploy-action-python@master
env:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
BASE_BRANCH: master # The branch the action should deploy from.
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: docs/_build/html # The folder the action should deploy. This example folder is generated by Sphinx
BUILD_SCRIPT: pip install .[all] && make docs-build && touch docs/_build/html/.nojekyll # The build script the action should run prior to deploying.The env portion of the workflow must be configured before the action will work. You can add these in the env section found in the examples above. Any secrets must be referenced using the bracket syntax and stored in the GitHub repositories Settings/Secrets menu. You can learn more about setting environment variables with GitHub actions here.
Below you'll find a description of what each option does.
| Key | Value Information | Type | Required |
|---|---|---|---|
GITHUB_TOKEN |
In order for GitHub to trigger the rebuild of your page you must provide the action with the repositories provided GitHub token. This can be referenced in the workflow yml file by using ${{ secrets.GITHUB_TOKEN }}. Only required if an access token is not provided. Please note there is currently an issue affecting the use of this token, you can learn more here. |
secrets |
Yes |
ACCESS_TOKEN |
Depending on the repository permissions you may need to provide the action with a GitHub personal access token instead of the provided GitHub token in order to deploy. You can learn more about how to generate one here. This should be stored as a secret. | secrets |
No |
BRANCH |
This is the branch you wish to deploy to, for example gh-pages or docs. |
env |
Yes |
FOLDER |
The folder in your repository that you want to deploy. If your build script compiles into a directory named build you'd put it here. Folder paths cannot have a leading / or ./. |
env |
Yes |
BASE_BRANCH |
The base branch of your repository which you'd like to checkout prior to deploying. This defaults to master. |
env |
No |
BUILD_SCRIPT |
If you require a build script to compile your code prior to pushing it you can add the script here. The Docker container which powers the action runs Node which means npm commands are valid. If you're using a static site generator such as Jekyll I'd suggest compiling the code prior to pushing it to your base branch. |
env |
No |
CNAME |
If you're using a custom domain, you will need to add the domain name to the CNAME environment variable. If you don't do this GitHub will wipe out your domain configuration after each deploy. This value will look something like this: jives.dev. |
env |
No |
With the action correctly configured you should see the workflow trigger the deployment under the configured conditions.
