How do I install Hugo extended version with peaceiris/actions-hugo?

Set the 'extended: true' parameter in the action's inputs. The README includes a clear example in the options section for enabling extended features like SCSS processing.

Is peaceiris/actions-hugo faster than Docker-based Hugo actions?

Yes, it's significantly faster because it uses a JavaScript implementation that completes in seconds, whereas Docker-based actions can take over a minute due to image building and pulling, as explained in the README.

How can I cache Hugo Modules to speed up my GitHub Actions builds?

Use the caching tips from the README: define HUGO_CACHEDIR as an environment variable and integrate actions/cache with a key based on go.sum files to store and restore module caches efficiently.

Can peaceiris/actions-hugo run on Windows GitHub runners?

Yes, it supports Windows runners (e.g., windows-2019) alongside Linux and macOS, as indicated in the OS support table, making it versatile for multi-platform workflows.

What's the difference between peaceiris/actions-hugo and other Hugo setup actions?

This action prioritizes speed with a non-Docker approach and offers extensive, practical examples for advanced use cases like PostCSS, whereas some alternatives may be slower or less documented.

How to set up PostCSS with peaceiris/actions-hugo in my workflow?

Follow the workflow example in the tips section: add actions/setup-node for Node.js, cache npm dependencies, run 'npm ci', and then build with Hugo, ensuring all PostCSS dependencies are installed.

Open-Awesome

GitHub Actions for Hugo extended

MITTypeScriptv3.2.1

A GitHub Action to quickly install Hugo (including extended version) and build static sites on Linux, macOS, and Windows runners.

Visit Website GitHub

1.6k stars95 forks0 contributors

What is GitHub Actions for Hugo extended?

peaceiris/actions-hugo is a GitHub Action that automates the installation and setup of Hugo for continuous integration and deployment workflows. It allows developers to quickly install Hugo (including the extended version) on GitHub Actions runners across Linux, macOS, and Windows, enabling fast static site builds. The action solves the problem of manually managing Hugo versions and dependencies in CI/CD pipelines.

Target Audience

Developers and teams using Hugo to build static websites who want to automate their build and deployment process with GitHub Actions. It's particularly useful for those managing documentation sites, blogs, or portfolios with Hugo.

Value Proposition

Developers choose this action because it's faster than Docker-based alternatives, supports all major platforms and Hugo features out of the box, and comes with extensive documentation and examples for real-world workflows.

Overview

GitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.

Use Cases

Best For

Automating Hugo site builds and deployments with GitHub Actions
Setting up CI/CD pipelines for static sites built with Hugo
Using Hugo extended version and Hugo Modules in automated workflows
Building and deploying documentation sites or blogs with GitHub Pages
Integrating PostCSS, Asciidoctor, or other tools with Hugo builds
Ensuring consistent Hugo versions across development and production environments

Not Ideal For

Projects using CI/CD platforms other than GitHub Actions, such as GitLab CI or Jenkins
Teams requiring Docker-based builds for containerized consistency across development and production
Organizations with strict security policies that restrict third-party GitHub Actions due to compliance risks

Pros & Cons

Pros

Cross-Platform Support

Works seamlessly on Ubuntu, macOS, and Windows GitHub Actions runners, as shown in the OS support table, ensuring flexibility for diverse environments.

Fast Execution Time

Uses a JavaScript/TypeScript implementation to complete in seconds, avoiding the slower Docker-based approaches that took over a minute, as noted in the migration to v2.

Extended Hugo Features

Supports Hugo extended version and Hugo Modules out of the box with simple configuration options, enabling advanced site-building capabilities like SCSS.

Comprehensive Workflow Examples

Provides ready-to-use examples for real-world scenarios like PostCSS, Asciidoctor, and non-ASCII filenames, reducing setup time for common integrations.

Cons

GitHub Ecosystem Lock-in

Exclusively designed for GitHub Actions, making it unusable for projects on other CI/CD platforms and limiting portability.

Additional Setup for Advanced Tools

Integrating features like PostCSS or Asciidoctor requires extra steps and dependencies, as shown in the tips section, adding complexity beyond basic Hugo setup.

Reliance on External Version Sources

Fetching the latest Hugo version depends on Homebrew formulae, which could introduce reliability issues if the source changes or becomes unavailable.

Frequently Asked Questions

Related Projects

GitHub Actions for mdBook

GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.

Stars329

Forks25

Last commit3 months ago

Runs a WebPageTest audit and prints the results as commit comment

⚡️🚀 Action to print webPagetest.org results

Stars57

Forks7

Last commit3 years ago

JS Build Actions

GitHub Actions for running Javascript build tools and committing file changes

Stars54

Forks16

Last commit5 years ago

Generate OG Image

Generate open graph images with Github Action from Markdown files

Stars48

Forks11

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub