Skip to content

Commit

Permalink
Add GitHub Actions for Hugo
Browse files Browse the repository at this point in the history
I wrote these myself, with some help from ChatGPT.
I originally wrote these for my personal web site.
  • Loading branch information
booch committed Mar 4, 2024
1 parent 5c02b4b commit 14b224d
Show file tree
Hide file tree
Showing 3 changed files with 182 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/hugo-add-theme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Hugo - Add Theme

# Original source: htts://github.com/boochtek/hugo-add-theme
# Original author: Craig Buchek (@booch) with help from ChatGPT.

on:
# Run this workflow manually from the Actions tab.
workflow_dispatch:
inputs:
theme_url:
description: "URL of the theme to add"
required: true
type: string

permissions:
contents: write

defaults:
run:
shell: bash

jobs:
gugo-add-theme:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.120.2
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: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Add git submodule pointing at the theme
run: |
THEME_URL="${{ inputs.theme_url }}"
THEME_NAME="$(basename ${THEME_URL%.*})"
git submodule add "$THEME_URL" "themes/${THEME_NAME}"
git submodule update --init --recursive
- name: Add theme to config # TODO
run: |
echo "OK"
53 changes: 53 additions & 0 deletions .github/workflows/hugo-init.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Hugo - Initialize

# Original source: htts://github.com/boochtek/hugo-init
# Original author: Craig Buchek (@booch).

# TODO:
# Tell user what to do next.
# Determine the latest Hugo version.
# Change baseURL in config file to "https://$(cat CNAME)/", if it exists.
# Allow setting languageCode to something other than 'en-us'.
# Allow setting title to something other than 'My New Hugo Site'.

on:
# Run manually from the Actions tab.
workflow_dispatch:

# Set permissions of the GITHUB_TOKEN to allow pushing.
permissions:
contents: write

defaults:
run:
shell: bash

jobs:
hugo-init:
runs-on: ubuntu-latest
env:
HUGO_VERSION: "0.120.4"
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Make sure we don't already have a Hugo config
run: |
[[ ! -f hugo.toml && ! -f hugo.yaml && ! -f hugo.json && ! -d config ]]
- name: Install Hugo CLI
run: |
HUGO_DEB_URL="https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb"
wget -O "${{ runner.temp }}/hugo.deb" "$HUGO_DEB_URL"
sudo dpkg -i "${{ runner.temp }}/hugo.deb"
- name: Initalize Hugo
run: |
hugo new site . --force
- name: Make sure any new empty directories get committed
run: |
find . -type d -empty -not -regex '.*/\.git/.*' -exec touch '{}/.gitkeep' ';'
- name: Commit changes
uses: EndBug/add-and-commit@v9
with:
message: Add Hugo
84 changes: 84 additions & 0 deletions .github/workflows/hugo-publish-github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Hugo - Publish to GitHub Pages

# Original source: htts://github.com/boochtek/hugo-publish-github-pages
# Original author: Craig Buchek (@booch) with help from ChatGPT

on:
# Run on pushes to the `main` branch.
push:
branches:
- main

# Allow running this workflow manually from the Actions tab.
workflow_dispatch:

# Set 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

defaults:
run:
shell: bash

jobs:
hugo-build:
runs-on: ubuntu-latest
steps:
- name: Install Hugo CLI
run: |
LATEST_RELEASE_JSON=$(curl -s https://api.github.com/repos/gohugoio/hugo/releases/latest)
HUGO_VERSION=$(echo $LATEST_RELEASE_JSON | jq -r '.tag_name')
HUGO_DEB_URL="https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb"
wget -O "${{ runner.temp }}/hugo.deb" "$HUGO_DEB_URL"
sudo dpkg -i ${{ runner.temp }}/hugo.deb
# - name: Install Dart Sass
# run: sudo snap install dart-sass

- name: Checkout
uses: actions/checkout@v4
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 || -f npm-shrinkwrap.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@v2
with:
path: ./public

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

0 comments on commit 14b224d

Please sign in to comment.