actions-marketplace-validations/Hugo Build and Deploy

Automatically builds and deploys Hugo website, works with submodules

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stalelast commit Aug 28, 2022
License
MIT
Runtime
Deprecated runtime

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions-marketplace-validations/aormsby_hugo-deploy-to-pages@4a8fff48550a87d829c1efa8831f42f73ed09a4e # no releases — HEAD as of 2026-07-13

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
hugo_publish_directoryName of Hugo publish directory, Hugo default is "public"yespublic
source_branchBranch with source code for the build, this should be checked out by actions/checkout stepyes
release_branchBranch where site is built and deployed, separate from source branch for easy access to build historyyes
merge_argsArgs for merging the source branch into the release branch, default is to take all changes from sourceyes-s recursive -Xtheirs
submodule_release_branchIf your Hugo publish directory is a git submodule inside your main project, this sets the branch to publish to in that submoduleno
full_rebuildIf 'true', clear build directory and build entire site (clear step ignores files in the 'do_not_delete_regex' pattern)yesfalse
full_rebuild_verboseIf 'true', prints out saved/deleted files and directories before performing the cleaning operationyesfalse
do_not_delete_regexFiles to save when cleaning deploy directory with "full_rebuild" option, regex input required (be careful with special characters like ".")no
commit_messageCustom commit message for release (default message provided, default description always added)no
hugo_build_optionsInclude additional Hugo build options as a single string, e.g. "--buildFuture" or "--verbose""no
git_config_userGit user credentials for sigining commit, (set to "null" for no config)yesAction - Hugo Deploy
git_config_emailGit email credentials for sigining commit (set to "null" for no config)yesaction@github.com
strict_build_modeIf set to "false", hugo builds with warnings will be allowed to proceed. Defaults to "true", Hugo warnings will cause action failure.yestrue
tag_releaseSet "true" to tag release with build numberyesfalse
test_modeIf set to "true", runs verification test on all inputs and any testable actions that use themyesfalse
namedescription
was_new_build_createdtrue when new build was made and published, false on failure or safe exit (nothing new to build)