github/hugo

Fork 0

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00

Bjørn Erik Pedersen 8859be1c01

Merge commit '87de22d7464e239c775fbd48ebce1665d5b1e80d'

2023-07-29 11:17:28 +02:00

5.6 KiB

Raw Blame History

title

description

Prerequisites

Create a GitHub account
Install Git
Create a Hugo site and test it locally with hugo server.

Types of sites

There are three types of GitHub Pages sites: project, user, and organization. Project sites are connected to a specific project hosted on GitHub. User and organization sites are connected to a specific account on GitHub.com.

{{% note %}} See the GitHub Pages documentation to understand the requirements for repository ownership and naming.

Procedure

Step 1: Create a GitHub repository.
Step 2: Push your local repository to GitHub.
Step 3: Visit your GitHub repository. From the main menu choose Settings > Pages. In then center of your screen you will see this:

{style="max-width: 280px"}

Step 4: Change the Source to GitHub Actions. The change is immediate; you do not have to press a Save button.

{style="max-width: 280px"}

Step 5: Create an empty file in your local repository.

.github/workflows/hugo.yaml

Step 6: Copy and paste the YAML below into the file you created. Change the branch name and Hugo version as needed.

Sample workflow for building and deploying a Hugo site to GitHub Pages

name: Deploy Hugo site to Pages

on:

Runs on pushes targeting the default branch

push: branches: - main

Allows you to run this workflow manually from the Actions tab

workflow_dispatch:

Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

permissions: contents: read pages: write id-token: write

Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.

However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

concurrency: group: "pages" cancel-in-progress: false

Default to bash

defaults: run: shell: bash

jobs:

Build job

build: runs-on: ubuntu-latest env: HUGO_VERSION: 0.115.1 steps: - name: Install Hugo CLI run: | wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb - name: Install Dart Sass run: sudo snap install dart-sass - name: Checkout uses: actions/checkout@v3 with: submodules: recursive fetch-depth: 0 - name: Setup Pages id: pages uses: actions/configure-pages@v3 - name: Install Node.js dependencies run: " -f package-lock.json && npm ci || true" - name: Build with Hugo env: # For maximum backward compatibility with Hugo modules HUGO_ENVIRONMENT: production HUGO_ENV: production run: | hugo
--gc
--minify
--baseURL "${{ steps.pages.outputs.base_url }}/" - name: Upload artifact uses: actions/upload-pages-artifact@v1 with: path: ./public

Deployment job

deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest needs: build steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v2 {{< /code >}}

Step 7: Commit the change to your local repository with a commit message of something like "Add workflow", and push to GitHub.
Step 8: From GitHub's main menu, choose Actions. You will see something like this:

{style="max-width: 350px"}

Step 9: When GitHub has finished building and deploying your site, the color of the status indicator will change to green.