aormsby/Hugo Build and Deploy
Automatically builds and deploys Hugo website, works with submodules
View on GitHubTrust Signals
- Scorecard Score
- Scorecard 2–4scored Jul 6, 2026
- Maintenance Recency
- Stalelast commit Aug 28, 2022
- License
- MIT
- Runtime
- Deprecated runtime
Pinned Snippet
uses: aormsby/hugo-deploy-to-pages@4a8fff48550a87d829c1efa8831f42f73ed09a4e # v2.1.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| hugo_publish_directory | Name of Hugo publish directory, Hugo default is "public" | yes | public |
| source_branch | Branch with source code for the build, this should be checked out by actions/checkout step | yes | — |
| release_branch | Branch where site is built and deployed, separate from source branch for easy access to build history | yes | — |
| merge_args | Args for merging the source branch into the release branch, default is to take all changes from source | yes | -s recursive -Xtheirs |
| submodule_release_branch | If your Hugo publish directory is a git submodule inside your main project, this sets the branch to publish to in that submodule | no | — |
| full_rebuild | If 'true', clear build directory and build entire site (clear step ignores files in the 'do_not_delete_regex' pattern) | yes | false |
| full_rebuild_verbose | If 'true', prints out saved/deleted files and directories before performing the cleaning operation | yes | false |
| do_not_delete_regex | Files to save when cleaning deploy directory with "full_rebuild" option, regex input required (be careful with special characters like ".") | no | — |
| commit_message | Custom commit message for release (default message provided, default description always added) | no | — |
| hugo_build_options | Include additional Hugo build options as a single string, e.g. "--buildFuture" or "--verbose"" | no | — |
| git_config_user | Git user credentials for sigining commit, (set to "null" for no config) | yes | Action - Hugo Deploy |
| git_config_email | Git email credentials for sigining commit (set to "null" for no config) | yes | action@github.com |
| strict_build_mode | If set to "false", hugo builds with warnings will be allowed to proceed. Defaults to "true", Hugo warnings will cause action failure. | yes | true |
| tag_release | Set "true" to tag release with build number | yes | false |
| test_mode | If set to "true", runs verification test on all inputs and any testable actions that use them | yes | false |
Outputs
| name | description |
|---|---|
| was_new_build_created | true when new build was made and published, false on failure or safe exit (nothing new to build) |