https://github.com/chabad360/hugo-actions

🚀 Use Hugo with GitHub Actions 🚀
https://github.com/chabad360/hugo-actions

actions hugo workflow

Last synced: 14 days ago
JSON representation

🚀 Use Hugo with GitHub Actions 🚀

• Host: GitHub
• URL: https://github.com/chabad360/hugo-actions
• Owner: chabad360
• License: mit
• Created: 2019-11-19T00:26:44.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-03T01:33:40.000Z (5 months ago)
• Last Synced: 2024-10-14T18:41:34.920Z (22 days ago)
• Topics: actions, hugo, workflow
• Language: Shell
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  


    Image Credit: Peaceiris

  

  


  Build Your Hugo Site in GitHub Actions

  

  


    

      gohugoio/hugo: The world’s fastest framework for building websites

    

  

  

    


    🚀

    

      

    

    

      

    

    

      

    

    🚀

    

  



 


This action builds your Hugo Site using the latest Hugo Extended.

This action also contains support for several external Hugo Helpers:

| Name | Support |

| ---- | :-----: |

| reStructuredText |️ ✔️ |

| Pandoc | ✔️ |

| Asciidoctor | ✔️ |

| PostCSS | ✔️ |

| Pygments | ✔️ |

| Babel | ✔️ |

| Hugo Modules | ✔️ |

If your site requires the use of another external helper, submit an issue and I'll try to add it.

## ⭐ Getting started

This is a basic `workflow.yml` to get you started (for more information scroll down to [⭐ Inputs](#-inputs)):

```yaml

name: Build Site

on:

  push:

    branches:

      - master

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Repo

        uses: actions/checkout@master

        with:

          submodules: true

      - name: Build Site

        uses: chabad360/hugo-actions@master

```

### ⭐ Inputs

| Key |  Description | Required | Default |

| --- | ------------ | :------: | ------- |

| `buildPath` | The path to build the site into. | ❌ | `public`|

| `hugoVersion` | The version Hugo to use (append `extended_` to the begining to use the extended version). | ❌ | Latest Hugo Extended |

| `args` | Arguments to pass to Hugo | ❌ | `--gc --minify --cleanDestinationDir`|

#### Usage

```yaml

- name: Publish Site

  uses: chabad360/hugo-actions@master

  with:

    buildPath: 'public'

    # Use if you have a need to build the site to another directory

    hugoVersion: 'extended_0.58.3'

    # Use if your site requires a specific version of Hugo

    # Append "extended_" to the begining to use Hugo Extended

    args: --gc --minify --cleanDestinationDir

    # Use if you want to pass some custom arguments to Hugo

```

## ⭐ Credit

This project is partially based on [mattbailey/actions-hugo](https://github.com/mattbailey/actions-hugo)