https://github.com/k-phoen/hugo-gh-pages-action
Builds and deploys Hugo-generated websites to GitHub Pages
https://github.com/k-phoen/hugo-gh-pages-action
Last synced: 7 months ago
JSON representation
Builds and deploys Hugo-generated websites to GitHub Pages
- Host: GitHub
- URL: https://github.com/k-phoen/hugo-gh-pages-action
- Owner: K-Phoen
- License: mit
- Created: 2019-11-24T16:42:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-21T15:36:11.000Z (over 4 years ago)
- Last Synced: 2024-09-17T17:48:24.942Z (about 1 year ago)
- Language: Shell
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hugo Deploys for GitHub Pages
Builds and deploys Hugo-generated websites to GitHub Pages
## Inputs
### `hugo_version`
**Required** Version of Hugo to use. Default `"0.59.1"`. See https://github.com/gohugoio/hugo/releases
### `build_folder`
**Required** Folder in which hugo generates the website. Default `"public".
### `build_branch`
**Required** Branch in which the website is published. Default `"master".
### `github_token`
**Required** Token to use to deploy the new version. `${{ github.token }}` or a
[personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
if you need to [clone submodules](https://github.com/actions/checkout#checkout-private-submodules)
(and be sure that the submodule is configured via `https` and not `ssh`).
## Outputs
None.
## Example usage
```yaml
# .github/workflows/deploy.yml
name: Deploy
push:
branches: [master]
jobs:
hugo_deploy:
name: Hugo
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v1
with:
depth: 1
submodules: true
token: ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }}
- uses: K-Phoen/hugo-gh-pages-action@master
with:
github_token: ${{ secrets.GITHUB_PERSONAL_ACCESS_TOKEN }}
```
## License
This library is under the [MIT](LICENSE.md) license.