[![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) [![Release Feed](https://img.shields.io/badge/release-feed-yellow)](https://github.com/peaceiris/actions-hugo/releases.atom) ![Test](https://github.com/peaceiris/actions-hugo/workflows/Test/badge.svg?branch=master&event=push) [![CodeFactor](https://www.codefactor.io/repository/github/peaceiris/actions-hugo/badge)](https://www.codefactor.io/repository/github/peaceiris/actions-hugo) [![codecov](https://codecov.io/gh/peaceiris/actions-hugo/branch/master/graph/badge.svg)](https://codecov.io/gh/peaceiris/actions-hugo) [![Maintainability](https://api.codeclimate.com/v1/badges/ebf2eef3a046b396ba9c/maintainability)](https://codeclimate.com/github/peaceiris/actions-hugo/maintainability) GitHub Actions for Hugo ## GitHub Actions for Hugo - [gohugoio/hugo: The world’s fastest framework for building websites.](https://github.com/gohugoio/hugo) This **Hugo Setup Action** can install **Hugo** to a virtual machine of **GitHub Actions**. **Hugo extended** version, **Hugo Modules**, Linux (Ubuntu), macOS, and Windows are supported. From `v2`, this Hugo Setup Action has 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 in less than a few seconds. (A docker base action was taking about 1 min or more execution time to build and pull a docker image.) | OS (runs-on) | ubuntu-18.04 | macos-latest | windows-2019 | |---|:---:|:---:|:---:| | Support | ✅️ | ✅️ | ✅️ | | Hugo type | Hugo Extended | Hugo Modules | Latest Hugo | |---|:---:|:---:|:---:| | Support | ✅️ | ✅️ | ✅️ | ## 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) - [Tips](#tips) - [⭐️ Read Hugo version from file](#%EF%B8%8F-read-hugo-version-from-file) - [⭐️ Workflow for autoprefixer and postcss-cli](#%EF%B8%8F-workflow-for-autoprefixer-and-postcss-cli) - [⭐️ Workflow for asciidoctor](#%EF%B8%8F-workflow-for-asciidoctor) - [CHANGELOG](#changelog) - [License](#license) - [About Maintainer](#about-maintainer) - [Maintainer Notes](#maintainer-notes) ## Getting started ### ⭐️ Create your workflow An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for GitHub Pages]. For the first deployment, we have to do this operation: [First Deployment with `GITHUB_TOKEN` - peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token) [GitHub Actions for GitHub Pages]: 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) ```yaml name: github pages on: push: branches: - master jobs: deploy: runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v2 with: submodules: true # Fetch Hugo themes (true OR recursive) fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '0.71.1' # extended: true - name: Build run: hugo --minify - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public ```
Back to TOC ☝️
## Options ### ⭐️ Use Hugo extended Set `extended: true` to use a Hugo extended version. ```yaml - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '0.71.1' 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 with: hugo-version: 'latest' ``` This action fetches the latest version of Hugo by [hugo | Homebrew Formulae](https://formulae.brew.sh/formula/hugo)
Back to TOC ☝️
## Tips ### ⭐️ Read Hugo version from file How to sync a Hugo version between a Docker Compose and a GitHub Actions workflow via `.env` file. Write a `HUGO_VERSION` to the `.env` file like the following and push it to a remote branch. ```sh HUGO_VERSION=0.71.1 ``` Next, add a step to read a Hugo version from the `.env` file. ```yaml - name: Read .env id: hugo-version run: | . ./.env echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}" - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '${{ steps.hugo-version.outputs.HUGO_VERSION }}' extended: true ``` Here is a `docker-compose.yml` example. ```yaml version: '3' services: hugo: container_name: hugo image: "peaceiris/hugo:v${HUGO_VERSION}" # image: peaceiris/hugo:v${HUGO_VERSION}-mod # Hugo Modules ports: - 1313:1313 volumes: - ${PWD}:/src command: - server - --bind=0.0.0.0 - --buildDrafts ``` The alpine base Hugo Docker image is provided on the following repository. > [peaceiris/hugo-extended-docker: Hugo alpine base Docker image (Hugo extended and Hugo Modules)](https://github.com/peaceiris/hugo-extended-docker) ### ⭐️ Workflow for autoprefixer and postcss-cli Here is an example workflow for the [google/docsy] Hugo theme. This theme needs `autoprefixer` and `postcss-cli` to build a project. The following workflow is tested on [google/docsy-example]. [google/docsy]: https://github.com/google/docsy [google/docsy-example]: https://github.com/google/docsy-example A workflow for the Hugo Babel pipeline is also the same as follows. ```yaml name: github pages on: push: branches: - master jobs: deploy: runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v2 with: submodules: recursive # Fetch the Docsy theme fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '0.71.1' extended: true - name: Setup Node uses: actions/setup-node@v1 with: node-version: '12.x' - name: Cache dependencies uses: actions/cache@v1 with: path: ~/.npm key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} restore-keys: | ${{ runner.os }}-node- - run: npm ci - run: hugo --minify - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} ``` ### ⭐️ Workflow for asciidoctor Here is an example workflow for a Hugo project using `asciidoctor`. ```yaml name: github pages on: push: branches: - master jobs: deploy: runs-on: ubuntu-18.04 steps: - uses: actions/checkout@v2 with: submodules: true # Fetch Hugo themes (true OR recursive) fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '0.71.1' extended: true - name: Setup Ruby uses: ruby/setup-ruby@v1 with: ruby-version: 2.7 - run: gem install asciidoctor - name: Run Hugo run: | alias asciidoctor="asciidoctor --attribute=experimental=true --attribute=icons=font" hugo --minify - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} ```
Back to TOC ☝️
## CHANGELOG - [CHANGELOG.md](CHANGELOG.md) ## License - [MIT License - peaceiris/actions-hugo] [MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE ## About Maintainer - [peaceiris homepage](https://peaceiris.com/) - [GitHub Action Hero: Shohei Ueda - The GitHub Blog](https://github.blog/2020-03-22-github-action-hero-shohei-ueda/) ## Maintainer Notes Run `npm test` on a Docker container. ```sh # On container make build make all # Release script on host ./release.sh ```
Back to TOC ☝️