rules_hugo
 |
 |
| Rules | Hugo |
Bazel rules for building static websites with Hugo.
Repository Rules
| Name | Description |
|---|---|
| hugo_repository | Load hugo dependency for this repo. |
| github_hugo_theme | Load a hugo theme from github. |
Build Rules
| Name | Description |
|---|---|
| hugo_site | Declare a hugo site. |
| hugo_theme | Declare a hugo theme. |
Usage
Add rules_hugo to your WORKSPACE and add a theme from github
# Update these to latest
RULES_HUGO_COMMIT = "..."
RULES_HUGO_SHA256 = "..."
http_archive(
name = "build_stack_rules_hugo",
url = "https://github.com/stackb/rules_hugo/archive/%s.zip" % RULES_HUGO_COMMIT,
sha256 = RULES_HUGO_SHA256,
strip_prefix = "rules_hugo-%s" % RULES_HUGO_COMMIT
)
load("@build_stack_rules_hugo//hugo:rules.bzl", "hugo_repository", "github_hugo_theme")
#
# Load hugo binary itself
#
# Optionally, load a specific version of Hugo, with the 'version' argument
hugo_repository(
name = "hugo",
)
#
# This makes a filegroup target "@com_github_yihui_hugo_xmin//:files"
# available to your build files
#
github_hugo_theme(
name = "com_github_yihui_hugo_xmin",
owner = "yihui",
repo = "hugo-xmin",
commit = "c14ca049d0dd60386264ea68c91d8495809cc4c6",
)Declare a hugo_site in your BUILD file
load("@build_stack_rules_hugo//hugo:rules.bzl", "hugo_site", "hugo_theme", "hugo_serve")
# Declare a theme 'xmin'. In this case the `name` and
# `theme_name` are identical, so the `theme_name` could be omitted in this case.
hugo_theme(
name = "xmin",
theme_name = "xmin",
srcs = [
"@com_github_yihui_hugo_xmin//:files",
],
)
# Declare a site. Config file is required.
my_site_name = "basic"
hugo_site(
name = my_site_name,
config = "config.toml",
content = [
"_index.md",
"about.md",
],
quiet = False,
theme = ":xmin",
)
# Run local development server
hugo_serve(
name = "local_%s" % my_site_name,
dep = [":%s" % my_site_name],
)
# Tar it up
pkg_tar(
name = "%s_tar" % my_site_name,
srcs = [":%s" % my_site_name],
)Build the site
The hugo_site target emits the output in the bazel-bin directory.
$ bazel build :basic
[...]
Target //:basic up-to-date:
bazel-bin/basic
[...]$ tree bazel-bin/basic
bazel-bin/basic
├── 404.html
├── about
│ └── index.html
[...]The pkg_tar target emits a %{name}_tar.tar file containing all the Hugo output files.
$ bazel build :basic_tar
[...]
Target //:basic up-to-date:
bazel-bin/basic_tar.tarEnd
See source code for details about additional rule attributes / parameters.