130 lines
4.1 KiB
Markdown
130 lines
4.1 KiB
Markdown
[](https://github.com/peaceiris/actions-hugo/blob/master/LICENSE)
|
||
[](https://github.com/peaceiris/actions-hugo/releases/latest)
|
||
[](https://github.com/peaceiris/actions-hugo/releases)
|
||
[](https://github.com/peaceiris/actions-hugo/actions)
|
||
|
||
<img width="400" alt="GitHub Actions for Hugo" src="./images/ogp.svg">
|
||
|
||
|
||
|
||
## GitHub Actions for Hugo extended and Modules
|
||
|
||
- [gohugoio/hugo: The world’s fastest framework for building websites.](https://github.com/gohugoio/hugo)
|
||
|
||
We can run Hugo on a virtual machine of GitHub Actions by this Hugo action. Hugo extended version and Hugo Modules are supported.
|
||
|
||
From `v2.0.0`, this Hugo action migrated to a JavaScript (TypeScript) action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than **4 sec**. (A docker base action was taking about 1 min or more execution time to build or pull.)
|
||
|
||
| OS (runs-on) | ubuntu-18.04 | macOS-10.14 | windows-2019 |
|
||
|---|:---:|:---:|:---:|
|
||
| Support | ✅️ | ✅️ | ✅️ |
|
||
|
||
| Hugo type | Hugo Extended | Hugo Modules | Latest Hugo |
|
||
|---|:---:|:---:|:---:|
|
||
| Support | ✅️ | ✅️ | ✅️ |
|
||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||
*Table of Contents*
|
||
|
||
- [Getting started](#getting-started)
|
||
- [⭐️ Create your workflow](#%EF%B8%8F-create-your-workflow)
|
||
- [Options](#options)
|
||
- [⭐️ Use Hugo extended](#%EF%B8%8F-use-hugo-extended)
|
||
- [⭐️ Use the latest version of Hugo](#%EF%B8%8F-use-the-latest-version-of-hugo)
|
||
- [License](#license)
|
||
- [About the author](#about-the-author)
|
||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||
|
||
|
||
|
||
## Getting started
|
||
|
||
### ⭐️ Create your workflow
|
||
|
||
An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
|
||
|
||
[GitHub Actions for deploying to GitHub Pages with Static Site Generators]: https://github.com/peaceiris/actions-gh-pages
|
||
|
||
[](https://github.com/peaceiris/actions-gh-pages)
|
||
|
||
|
||
|
||
|
||
```yaml
|
||
name: github pages
|
||
|
||
on:
|
||
push:
|
||
branches:
|
||
- master
|
||
|
||
jobs:
|
||
build-deploy:
|
||
runs-on: ubuntu-18.04
|
||
steps:
|
||
- uses: actions/checkout@master
|
||
# with:
|
||
# submodules: true
|
||
|
||
- name: Setup Hugo
|
||
uses: peaceiris/actions-hugo@v2.2.2
|
||
with:
|
||
hugo-version: '0.58.3'
|
||
# extended: true
|
||
|
||
- name: Build
|
||
run: hugo --gc --minify --cleanDestinationDir
|
||
|
||
- name: Deploy
|
||
uses: peaceiris/actions-gh-pages@v2.5.0
|
||
env:
|
||
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
|
||
PUBLISH_BRANCH: gh-pages
|
||
PUBLISH_DIR: ./public
|
||
```
|
||
|
||
|
||
|
||
## Options
|
||
|
||
### ⭐️ Use Hugo extended
|
||
|
||
Set `extended: true` to use a Hugo extended version.
|
||
|
||
```yaml
|
||
- name: Setup Hugo
|
||
uses: peaceiris/actions-hugo@v2.2.2
|
||
with:
|
||
hugo-version: '0.58.3'
|
||
extended: true
|
||
```
|
||
|
||
### ⭐️ Use the latest version of Hugo
|
||
|
||
Set `hugo-version: 'latest'` to use the latest version of Hugo.
|
||
|
||
```yaml
|
||
- name: Setup Hugo
|
||
uses: peaceiris/actions-hugo@v2.2.2
|
||
with:
|
||
hugo-version: 'latest'
|
||
```
|
||
|
||
This action fetches the latest version of Hugo by [hugo | Homebrew Formulae](https://formulae.brew.sh/formula/hugo)
|
||
|
||
|
||
|
||
## License
|
||
|
||
- [MIT License - peaceiris/actions-hugo]
|
||
|
||
[MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE
|
||
|
||
|
||
|
||
## About the author
|
||
|
||
- [peaceiris's homepage](https://peaceiris.com/)
|