actions-hugo/README.md

69 lines
2.0 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)
2019-05-21 21:05:36 +00:00
<img width="400" alt="GitHub Actions for Hugo extended" src="./images/ogp.svg">
2019-05-21 20:57:34 +00:00
2019-05-21 21:05:36 +00:00
## GitHub Actions for Hugo extended
2019-05-21 20:57:34 +00:00
- [gohugoio/hugo: The worlds fastest framework for building websites.](https://github.com/gohugoio/hugo)
## Getting started
### Create `main.workflow`
An example 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-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)
2019-05-21 20:57:34 +00:00
```hcl
workflow "GitHub Pages" {
2019-05-21 20:57:34 +00:00
on = "push"
resolves = ["deploy"]
}
action "is-branch-master" {
uses = "actions/bin/filter@master"
args = "branch master"
2019-05-21 20:57:34 +00:00
}
action "build" {
needs = "is-branch-master"
uses = "peaceiris/actions-hugo@v0.56.0"
2019-05-21 20:57:34 +00:00
args = ["--gc", "--minify", "--cleanDestinationDir"]
}
action "deploy" {
needs = "build"
uses = "peaceiris/actions-gh-pages@v1.0.1"
env = {
PUBLISH_DIR = "./public"
PUBLISH_BRANCH = "gh-pages"
}
secrets = ["ACTIONS_DEPLOY_KEY"]
}
2019-05-21 20:57:34 +00:00
```
## License
[MIT License - peaceiris/actions-hugo]
[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/)
2019-05-21 20:57:34 +00:00
<a href="https://www.patreon.com/peaceiris"><img src="./images/patreon.jpg" alt="peaceiris - Patreon" width="150px"></a>