Hugo Site on Master Branch

[sirinath]

How can the configuration be changed if the site is on the master branch?

What would be the repos structure with md, adoc files and output?

Is there any specifics in installing action for Hugo? Should both actions be installed?

[peaceiris]

If your default branch is master (main) and you are using the gh-pages as the GitHub Pages branch

Just follow the README.

If you are using master branch as the GitHub Pages branch

If you are a senior GitHub user, you know that the GitHub Pages branch was limited to gh-pages or master only in the old days. Today, we can select any branch as the GitHub Pages branch.

• Project repository: Only gh-pages. Today, any branch.
• User repository (e.g. peaceiris/peaceiris.github.io): Only master. Today, any branch.

For more details and the latest spec, see the official documentation: GitHub Pages Documentation - GitHub Docs

Here is an example workflow for the old GitHub users.

Usecase:

• source branch has a Hugo project (Markdown files, Hugo templates, etc.)
• master branch is the GitHub Pages branch including build assets (HTML, CSS, JavaScript, etc.)

We can select the GitHub Pages branch with the publish_branch input. (default is gh-pages).

name: GitHub Pages

on:
  push:
    branches:
      - source  # Set a branch name to trigger deployment

jobs:
  deploy:
    runs-on: ubuntu-20.04
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v2
        with:
          submodules: true  # Fetch Hugo themes (true OR recursive)
          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.87.0'

      - name: Build
        run: hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: master
          publish_dir: ./public

For more options and use cases, read the latest README.md

[sirinath]

Can the source and output be in the same branch?

[sirinath]

What does uses: peaceiris/actions-gh-pages@v3 do? Should it be uses: peaceiris/actions-master@v3?

[peaceiris]

Can the source and output be in the same branch?

We use this action to avoid this way.

If you do not know the basic concept and usage of the GitHub Pages and GitHub Actions, I recommend you to learn about those with the official documentation first.

[peaceiris]

What does uses: peaceiris/actions-gh-pages@v3 do? Should it be uses: peaceiris/actions-master@v3?

The uses field has an action name (owner/repository_name).

Introduction to GitHub Actions - GitHub Docs