Publish Hugo site with GitHub Actions

Published: September 21, 2020 , Updated: January 6, 2023

Talks about: github, github actions, hugo, and publish

The peaceiris/actions-gh-pages action allows to publish a Hugo site in your GitHub Action.

name: <PIPELINE>
jobs:
  build:
    runs-on: <RUN_ON>
    steps:
      - name: Deploy Website
        uses: peaceiris/[email protected]
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: <PUBLISH_DIR>
          force_orphan: true
          cname: <CNAME>

<PIPELINE>: The name of your pipeline.
<RUN_ON>: The runner to use, see GitHub’s own documentation for possible values.
<PUBLISH_DIR>: The file system location of the built site.
<CNAME>: The CNAME of your custom domain.