BrianSigafoos/hugo_site

Hugo static site builder → briansigafoos.github.io → briansigafoos.com

Hugo site for briansigafoos.com

Workflow

• Run npm run update to ensure everything is up to date, see script/update_dependencies.sh

  • brew bundle
  • npm upgrade --latest
  • npm run latest
    • git submodule foreach --recursive git checkout main
    • git submodule foreach --recursive git pull origin main

• Merge opened PR for dependencies

• Run hugo new content/<NAME>.md to add new posts to content/...

• Run npm run build to view site locally at http://localhost:1313

• Run npm run fix to run linters with autocorrect

• Create a PR with changes

• Deploy will happen via a Github Action automatically once merged

Recreate Github token to publish

In order to commit changes in BrianSigafoos/briansigafoos.github.io via the Github Action that uses peaceiris/actions-gh-pages@v4, follow these steps 1x yearly:

• Create a new "fine-grained" token from https://github.com/settings/tokens
  • Add permissions for "Contents" and only briansigafoos.github.io repo
  • Set expiration for max, currently 1 year
• Paste token into PERSONAL_TOKEN in this repo's Secrets > Actions: https://github.com/BrianSigafoos/hugo_site/settings/secrets/actions

Debugging

# Print out all the values under .Site or .Permalink
{{ printf "%#v" $.Site }}
{{ printf "%#v" .Permalink }}

# Print a list of all the variables scoped to the current context
# ".", aka "the dot"
{{ printf "%#v" . }}

Setup

• brew install hugo

• Setting up GitHub pages instructions

# https://stackoverflow.com/questions/47403358/fatal-in-unpopulated-submodule
git rm --cached . -rf

git add --all

# After a git clone, remove the public directory locally and then
# re-add the git submodule
rm -rf public

# https://gohugo.io/hosting-and-deployment/hosting-on-github/#step-by-step-instructions
git submodule add -b main git@github.com:BrianSigafoos/briansigafoos.github.io.git public

#
# Working with git submodules
#
# To get latest from the git submodule
git submodule update --recursive --remote
# Also
git submodule foreach --recursive git checkout main
git submodule foreach --recursive git pull origin main

Upgrade Hugo

brew upgrade hugo

Fix public sub repo

• cd public into sub repo
• Use git commands to fix, like git reset HEAD~1