@@ -121,9 +108,9 @@ Set `extended: true` to use a Hugo extended version.
```yaml
- name: Setup Hugo
- uses: peaceiris/actions-hugo@v3
+ uses: peaceiris/actions-hugo@v2
with:
- hugo-version: '0.119.0'
+ hugo-version: '0.62.2'
extended: true
```
@@ -133,7 +120,7 @@ Set `hugo-version: 'latest'` to use the latest version of Hugo.
```yaml
- name: Setup Hugo
- uses: peaceiris/actions-hugo@v3
+ uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
```
@@ -148,42 +135,6 @@ This action fetches the latest version of Hugo by [hugo | Homebrew Formulae](htt
## Tips
-### ⭐️ Caching Hugo Modules
-
-Insert a cache step before site-building as follows.
-
-First, to maximize compatibility with all Hugo versions, let's define the variable `HUGO_CACHEDIR`:
-
-```yaml
-# * ...
-
-jobs:
- deploy:
- runs-on: ubuntu-22.04
- env:
- HUGO_CACHEDIR: /tmp/hugo_cache # <- Define the env variable here, so that Hugo's cache dir is now predictible in your workflow and doesn't depend on the Hugo's version you're using.
-
-# * ...
-```
-
-Now, let's add the cache action call just above the _Build_ step:
-
-```yaml
-- uses: actions/cache@v4
- with:
- path: ${{ env.HUGO_CACHEDIR }} # <- Use the same env variable just right here
- key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
- restore-keys: |
- ${{ runner.os }}-hugomod-
-
-- name: Build
- run: hugo --minify
-```
-
-
-
### ⭐️ Read Hugo version from file
How to sync a Hugo version between a Docker Compose and a GitHub Actions workflow via `.env` file.
@@ -191,7 +142,7 @@ How to sync a Hugo version between a Docker Compose and a GitHub Actions workflo
Write a `HUGO_VERSION` to the `.env` file like the following and push it to a remote branch.
```sh
-HUGO_VERSION=0.119.0
+HUGO_VERSION=0.62.2
```
Next, add a step to read a Hugo version from the `.env` file.
@@ -201,10 +152,10 @@ Next, add a step to read a Hugo version from the `.env` file.
id: hugo-version
run: |
. ./.env
- echo "HUGO_VERSION=${HUGO_VERSION}" >> "${GITHUB_OUTPUT}"
+ echo "::set-output name=HUGO_VERSION::${HUGO_VERSION}"
- name: Setup Hugo
- uses: peaceiris/actions-hugo@v3
+ uses: peaceiris/actions-hugo@v2
with:
hugo-version: '${{ steps.hugo-version.outputs.HUGO_VERSION }}'
extended: true
@@ -219,8 +170,7 @@ services:
hugo:
container_name: hugo
image: "peaceiris/hugo:v${HUGO_VERSION}"
- # image: peaceiris/hugo:v${HUGO_VERSION}-mod # Hugo Modules
- # image: peaceiris/hugo:v${HUGO_VERSION}-full # Hugo Modules and Node.js
+ # image: peaceiris/hugo:v${HUGO_VERSION}-mod # Hugo Modules
ports:
- 1313:1313
volumes:
@@ -239,154 +189,6 @@ The alpine base Hugo Docker image is provided on the following repository.
Back to TOC ☝️
-[](https://www.repostatus.org/#active)
-[](https://github.com/peaceiris/actions-hugo/blob/main/LICENSE)
-[](https://github.com/peaceiris/actions-hugo/releases/latest)
-[](https://github.com/peaceiris/actions-hugo/releases)
-[](https://github.com/peaceiris/actions-hugo/releases.atom)
-
-
-[](https://www.codefactor.io/repository/github/peaceiris/actions-hugo)
-[](https://codecov.io/gh/peaceiris/actions-hugo)
-[](https://codeclimate.com/github/peaceiris/actions-hugo/maintainability)
-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.
+## GitHub Actions for Hugo
-[Hugo]: https://github.com/gohugoio/hugo
+- [gohugoio/hugo: The world’s fastest framework for building websites.](https://github.com/gohugoio/hugo)
-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.)
+We can run **Hugo** on a virtual machine of **GitHub Actions** by this Hugo action. **Hugo extended** version and **Hugo Modules** are supported.
-| OS (runs-on) | ubuntu-latest, ubuntu-20.04, ubuntu-22.04 | macos-latest | windows-2019 |
+From `v2`, 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-latest | windows-2019 |
|---|:---:|:---:|:---:|
| Support | ✅️ | ✅️ | ✅️ |
@@ -39,17 +31,14 @@ Thanks to this change, we can complete this action in less than a few seconds.
+
- [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)
- - [⭐️ Caching Hugo Modules](#%EF%B8%8F-caching-hugo-modules)
- [⭐️ 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)
- - [⭐️ Non-ascii Filename](#%EF%B8%8F-non-ascii-filename)
- [CHANGELOG](#changelog)
- [License](#license)
- [About Maintainer](#about-maintainer)
@@ -63,48 +52,46 @@ Thanks to this change, we can complete this action in less than a few seconds.
### ⭐️ 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)
+An example workflow `.github/workflows/gh-pages.yml` with [GitHub Actions for GitHub Pages]
[GitHub Actions for GitHub Pages]: https://github.com/peaceiris/actions-gh-pages
[](https://github.com/peaceiris/actions-gh-pages)
+
+
+
```yaml
-name: GitHub Pages
+name: github pages
on:
push:
branches:
- - main # Set a branch to deploy
- pull_request:
+ - master
jobs:
- deploy:
- runs-on: ubuntu-22.04
- concurrency:
- group: ${{ github.workflow }}-${{ github.ref }}
+ build-deploy:
+ runs-on: ubuntu-18.04
steps:
- - uses: actions/checkout@v4
- with:
- submodules: true # Fetch Hugo themes (true OR recursive)
- fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+ - uses: actions/checkout@v1
+ # with:
+ # submodules: true
- name: Setup Hugo
- uses: peaceiris/actions-hugo@v3
+ uses: peaceiris/actions-hugo@v2
with:
- hugo-version: '0.119.0'
+ hugo-version: '0.62.2'
# extended: true
- name: Build
run: hugo --minify
- name: Deploy
- uses: peaceiris/actions-gh-pages@v3
- if: github.ref == 'refs/heads/main'
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: ./public
+ uses: peaceiris/actions-gh-pages@v2
+ env:
+ ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ PUBLISH_BRANCH: gh-pages
+ PUBLISH_DIR: ./public
```