This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Hugo

Hugo rules

1: al_hugo_binary
2: al_hugo_run_binary
3: al_hugo_site
4: al_hugo_site_info
5: al_hugo_toolchain
6: Bazel targets
7: Changelog

1 - al_hugo_binary

al_hugo_binary

load("@com_alwaldend_src//bzl/rules/hugo:al_hugo_binary.bzl", "al_hugo_binary")

al_hugo_binary(name, arguments, site)

Run a hugo command

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
arguments	Hugo arguments	List of strings	optional	`[]`
site	Hugo site	Label	required

2 - al_hugo_run_binary

al_hugo_run_binary

load("@com_alwaldend_src//bzl/rules/hugo:al_hugo_run_binary.bzl", "al_hugo_run_binary")

al_hugo_run_binary(name, outs, arguments, hugo, out_dirs)

Run hugo binary as a build action

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
outs	Output files	List of labels; nonconfigurable	optional	`[]`
arguments	Hugo arguments	List of strings	optional	`[]`
hugo	Hugo binary to use	Label	required
out_dirs	Output directories	List of strings	optional	`[]`

3 - al_hugo_site

al_hugo_site

load("@com_alwaldend_src//bzl/rules/hugo:al_hugo_site.bzl", "al_hugo_site")

al_hugo_site(name, env, git, postcss, site, tools)

Define a hugo site

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
env	Hugo environment variables (support location statements, support make variables, support shell commands)	Dictionary: String -> String	optional	`{}`
git	Git info	Label	optional	`None`
postcss	Postcss target	Label	required
site	Hugo site archive	Label	required
tools	Tools that should be available for the build	List of labels	optional	`[]`

4 - al_hugo_site_info

AlHugoSiteInfo

load("@com_alwaldend_src//bzl/rules/hugo:al_hugo_site_info.bzl", "AlHugoSiteInfo")

AlHugoSiteInfo(site_archive, git_archive, env, env_script)

Information about a hugo site

FIELDS

Name	Description
site_archive	Site archive File (.tar)
git_archive	Git archive (.tar)
env	Environment variables
env_script	Shell script to export env variables

5 - al_hugo_toolchain

al_hugo_toolchain

load("@com_alwaldend_src//bzl/rules/hugo:al_hugo_toolchain.bzl", "al_hugo_toolchain")

al_hugo_toolchain(name, hugo)

Hugo toolchain

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
hugo	Hugo binary	Label	required

6 - Bazel targets

Name Info

al_hugo_binary

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_binary`
ruleClass	`bzl_library`
visibility	`//visibility:public`

al_hugo_binary.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_binary.stardoc`
ruleClass	`genrule`
ruleOutput	`//bzl/rules/hugo:al_hugo_binary.stardoc.md`
visibility	`//visibility:private`

al_hugo_binary.stardoc_raw

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_binary.stardoc_raw`
ruleClass	`stardoc_markdown_renderer`
ruleOutput	`//bzl/rules/hugo:al_hugo_binary.stardoc_raw.md`
visibility	`//visibility:private`

al_hugo_binary.stardoc_raw.extract

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_binary.stardoc_raw.extract`
ruleClass	`starlark_doc_extract`
ruleOutput	`//bzl/rules/hugo:al_hugo_binary.stardoc_raw.extract.binaryproto` `//bzl/rules/hugo:al_hugo_binary.stardoc_raw.extract.textproto`
visibility	`//visibility:private`

al_hugo_run_binary

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_run_binary`
ruleClass	`bzl_library`
visibility	`//visibility:public`

al_hugo_run_binary.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_run_binary.stardoc`
ruleClass	`genrule`
ruleOutput	`//bzl/rules/hugo:al_hugo_run_binary.stardoc.md`
visibility	`//visibility:private`

al_hugo_run_binary.stardoc_raw

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_run_binary.stardoc_raw`
ruleClass	`stardoc_markdown_renderer`
ruleOutput	`//bzl/rules/hugo:al_hugo_run_binary.stardoc_raw.md`
visibility	`//visibility:private`

al_hugo_run_binary.stardoc_raw.extract

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_run_binary.stardoc_raw.extract`
ruleClass	`starlark_doc_extract`
ruleOutput	`//bzl/rules/hugo:al_hugo_run_binary.stardoc_raw.extract.binaryproto` `//bzl/rules/hugo:al_hugo_run_binary.stardoc_raw.extract.textproto`
visibility	`//visibility:private`

al_hugo_site

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site`
ruleClass	`bzl_library`
visibility	`//visibility:public`

al_hugo_site.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site.stardoc`
ruleClass	`genrule`
ruleOutput	`//bzl/rules/hugo:al_hugo_site.stardoc.md`
visibility	`//visibility:private`

al_hugo_site.stardoc_raw

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site.stardoc_raw`
ruleClass	`stardoc_markdown_renderer`
ruleOutput	`//bzl/rules/hugo:al_hugo_site.stardoc_raw.md`
visibility	`//visibility:private`

al_hugo_site.stardoc_raw.extract

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site.stardoc_raw.extract`
ruleClass	`starlark_doc_extract`
ruleOutput	`//bzl/rules/hugo:al_hugo_site.stardoc_raw.extract.binaryproto` `//bzl/rules/hugo:al_hugo_site.stardoc_raw.extract.textproto`
visibility	`//visibility:private`

al_hugo_site_info

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site_info`
ruleClass	`bzl_library`
visibility	`//visibility:public`

al_hugo_site_info.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site_info.stardoc`
ruleClass	`genrule`
ruleOutput	`//bzl/rules/hugo:al_hugo_site_info.stardoc.md`
visibility	`//visibility:private`

al_hugo_site_info.stardoc_raw

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site_info.stardoc_raw`
ruleClass	`stardoc_markdown_renderer`
ruleOutput	`//bzl/rules/hugo:al_hugo_site_info.stardoc_raw.md`
visibility	`//visibility:private`

al_hugo_site_info.stardoc_raw.extract

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_site_info.stardoc_raw.extract`
ruleClass	`starlark_doc_extract`
ruleOutput	`//bzl/rules/hugo:al_hugo_site_info.stardoc_raw.extract.binaryproto` `//bzl/rules/hugo:al_hugo_site_info.stardoc_raw.extract.textproto`
visibility	`//visibility:private`

al_hugo_toolchain

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_toolchain`
ruleClass	`bzl_library`
visibility	`//visibility:public`

al_hugo_toolchain.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_toolchain.stardoc`
ruleClass	`genrule`
ruleOutput	`//bzl/rules/hugo:al_hugo_toolchain.stardoc.md`
visibility	`//visibility:private`

al_hugo_toolchain.stardoc_raw

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_toolchain.stardoc_raw`
ruleClass	`stardoc_markdown_renderer`
ruleOutput	`//bzl/rules/hugo:al_hugo_toolchain.stardoc_raw.md`
visibility	`//visibility:private`

al_hugo_toolchain.stardoc_raw.extract

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:al_hugo_toolchain.stardoc_raw.extract`
ruleClass	`starlark_doc_extract`
ruleOutput	`//bzl/rules/hugo:al_hugo_toolchain.stardoc_raw.extract.binaryproto` `//bzl/rules/hugo:al_hugo_toolchain.stardoc_raw.extract.textproto`
visibility	`//visibility:private`

changelog

location	`bzl/rules/hugo/BUILD.bazel:7:17`
name	`//bzl/rules/hugo:changelog`
ruleClass	`pkg_filegroup`
visibility	`//visibility:public`

changelog.changelog

location	`bzl/rules/hugo/BUILD.bazel:7:17`
name	`//bzl/rules/hugo:changelog.changelog`
ruleClass	`al_template_files`
ruleOutput	`//bzl/rules/hugo:changelog.doc.md`
visibility	`//visibility:private`

changelog.changelog_data

location	`bzl/rules/hugo/BUILD.bazel:7:17`
name	`//bzl/rules/hugo:changelog.changelog_data`
ruleClass	`al_git_run_binary`
ruleOutput	`//bzl/rules/hugo:changelog.changelog_data.yaml`
visibility	`//visibility:private`

changelog.changelog_files

location	`bzl/rules/hugo/BUILD.bazel:7:17`
name	`//bzl/rules/hugo:changelog.changelog_files`
ruleClass	`pkg_files`
visibility	`//visibility:private`

changelog.template

location	`bzl/rules/hugo/BUILD.bazel:7:17`
name	`//bzl/rules/hugo:changelog.template`
ruleClass	`_write_file`
ruleOutput	`//bzl/rules/hugo:changelog.template.md`
visibility	`//visibility:private`

libs

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:libs`
ruleClass	`bzl_library`
visibility	`//visibility:public`

libs.stardoc

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:libs.stardoc`
ruleClass	`pkg_filegroup`
visibility	`//visibility:public`

libs.stardoc_src

location	`bzl/rules/hugo/BUILD.bazel:12:19`
name	`//bzl/rules/hugo:libs.stardoc_src`
ruleClass	`pkg_files`
visibility	`//visibility:private`

readme

location	`bzl/rules/hugo/BUILD.bazel:56:10`
name	`//bzl/rules/hugo:readme`
ruleClass	`filegroup`
visibility	`//visibility:public`

readme.srcs

location	`bzl/rules/hugo/BUILD.bazel:56:10`
name	`//bzl/rules/hugo:readme.srcs`
ruleClass	`pkg_files`
visibility	`//visibility:private`

readme.with_children

location	`bzl/rules/hugo/BUILD.bazel:56:10`
name	`//bzl/rules/hugo:readme.with_children`
ruleClass	`pkg_filegroup`
visibility	`//visibility:public`

toolchain_remote_linux_amd64

location	`bzl/rules/hugo/BUILD.bazel:40:10`
name	`//bzl/rules/hugo:toolchain_remote_linux_amd64`
ruleClass	`toolchain`
visibility	`//visibility:public`

toolchain_remote_linux_amd64_impl

location	`bzl/rules/hugo/BUILD.bazel:47:18`
name	`//bzl/rules/hugo:toolchain_remote_linux_amd64_impl`
ruleClass	`al_hugo_toolchain`
visibility	`//visibility:private`

toolchain_type

location	`bzl/rules/hugo/BUILD.bazel:35:15`
name	`//bzl/rules/hugo:toolchain_type`
ruleClass	`toolchain_type`
visibility	`//visibility:public`

7 - Changelog

Fix hugo build in CI (70f831)
Fix al_hugo_run_binary, add al_http_server_binary (1bf299)
Partially remove pkg_tar from hugo, remove several registry modules (f59f94)
Add external ansible collections, rename some deps (99b3c7)
Move changelog rules to bzl/rules/git, improve ansible rules (c94123)
Move changelog rules to bzl/rules/changelog (4d59d6)
Move readme rules to bzl/rules/readme (95ea8d)
Move bzl rules to bzl/rules/bzl (57930e)
Move drawio rules to bzl/rules/drawio (b9c893)
Move hugo toolchain to bzl/rules/hugo (cdefa3)
Move hugo rules to bzl/rules/hugo, move go rules to /bzl/rules/go (cb079f)