https://github.com/crazy-max/ghaction-hugo

GitHub Action for Hugo, the world's fastest framework for building websites
https://github.com/crazy-max/ghaction-hugo

actions github-actions hugo

Last synced: 14 days ago
JSON representation

GitHub Action for Hugo, the world's fastest framework for building websites

• Host: GitHub
• URL: https://github.com/crazy-max/ghaction-hugo
• Owner: crazy-max
• License: mit
• Created: 2019-10-11T20:09:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-26T18:56:04.000Z (20 days ago)
• Last Synced: 2024-10-27T13:16:17.210Z (19 days ago)
• Topics: actions, github-actions, hugo
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/hugo-github-action
• Size: 4.78 MB
• Stars: 14
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-hugo.svg?style=flat-square)](https://github.com/crazy-max/ghaction-hugo/releases/latest)

[![GitHub marketplace](https://img.shields.io/badge/marketplace-hugo--github--action-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/hugo-github-action)

[![Test workflow](https://img.shields.io/github/actions/workflow/status/crazy-max/ghaction-hugo/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-hugo/actions?workflow=test)

[![Codecov](https://img.shields.io/codecov/c/github/crazy-max/ghaction-hugo?logo=codecov&style=flat-square)](https://codecov.io/gh/crazy-max/ghaction-hugo)

[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/crazy-max)

[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/crazyws)

## About

GitHub Action for [Hugo](https://gohugo.io/), the world's fastest framework for

building websites.

![Hugo GitHub Action](.github/ghaction-hugo.png)

___

* [Usage](#usage)

* [Customizing](#customizing)

  * [inputs](#inputs)

* [Contributing](#contributing)

* [License](#license)

## Usage

```yaml

name: hugo

on:

  push:

  pull_request:

jobs:

  hugo:

    runs-on: ubuntu-latest

    steps:

      -

        name: Checkout

        uses: actions/checkout@v4

      -

        name: Run Hugo

        uses: crazy-max/ghaction-hugo@v3

        with:

          version: latest

          extended: false

          args: --cleanDestinationDir --minify --verbose

      -

        name: Deploy to GitHub Pages

        if: github.event_name != 'pull_request'

        uses: crazy-max/ghaction-github-pages@v4

        with:

          target_branch: gh-pages

          build_dir: public

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## Customizing

### inputs

The following inputs can be used as `step.with` keys

| Name          | Type    | Default   | Description                      |

|---------------|---------|-----------|----------------------------------|

| `version`     | String  | `latest`  | Hugo version. Example: `v0.58.3` |

| `extended`    | Bool    | `false`   | Use Hugo extended                |

| `args`        | String  |           | Arguments to pass to Hugo        |

## Contributing

Want to contribute? Awesome! The most basic way to show your support is to star

the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)

or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this

journey continues indefinitely!

Thanks again for your support, it is much appreciated! :pray:

## License

MIT. See `LICENSE` for more details.