actions-hugo/README.md

101 lines
3.1 KiB
Markdown
Raw Normal View History

2019-05-21 20:57:34 +00:00
[![license](https://img.shields.io/github/license/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/blob/master/LICENSE)
[![release](https://img.shields.io/github/release/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases/latest)
[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases)
[![GitHub Actions status](https://github.com/peaceiris/actions-hugo/workflows/Test/badge.svg)](https://github.com/peaceiris/actions-hugo/actions)
2019-05-21 20:57:34 +00:00
2019-09-15 23:27:57 +00:00
<img width="400" alt="GitHub Actions for Hugo" src="./images/ogp.svg">
2019-05-21 20:57:34 +00:00
## GitHub Actions for Hugo extended and Modules
2019-05-21 20:57:34 +00:00
- [gohugoio/hugo: The worlds 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 action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than **1 sec**. (Docker base action was taking about 1 min execution time to build or pull.)
2019-05-21 20:57:34 +00:00
## Getting started
### Create `.github/workflows/gh-pages.yml`
2019-05-21 20:57:34 +00:00
2019-09-15 23:27:57 +00:00
An example workflow 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
[![peaceiris/actions-gh-pages - GitHub](https://gh-card.dev/repos/peaceiris/actions-gh-pages.svg?fullname)](https://github.com/peaceiris/actions-gh-pages)
![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
```yaml
2019-08-21 20:03:19 +00:00
name: github pages
on:
push:
branches:
- master
jobs:
build-deploy:
2019-08-21 17:54:38 +00:00
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@master
2019-09-04 16:50:24 +00:00
2019-09-15 23:27:57 +00:00
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
2019-09-15 23:27:57 +00:00
hugo-version: '0.58.2'
2019-09-04 16:50:24 +00:00
2019-09-15 23:27:57 +00:00
- name: Build
run: hugo --gc --minify --cleanDestinationDir
- name: Deploy
uses: peaceiris/actions-gh-pages@v2.3.1
env:
2019-09-05 18:09:36 +00:00
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: ./public
2019-05-21 20:57:34 +00:00
```
2019-09-15 23:27:57 +00:00
## Options
### Hugo extended
```yaml
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
hugo-version: '0.58.2'
extended: true
```
### Latest version of Hugo
```yaml
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
hugo-version: 'latest'
```
This action fetches the latest version of Hugo by [hugo | Homebrew Formulae](https://formulae.brew.sh/formula/hugo)
2019-09-15 23:27:57 +00:00
2019-05-21 20:57:34 +00:00
## License
- [MIT License - peaceiris/actions-hugo]
2019-05-21 20:57:34 +00:00
[MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE
2019-05-22 12:01:05 +00:00
## About the author
- [peaceiris's homepage](https://peaceiris.com/)