Documentation
¶
Overview ¶
Package util provides general filesystem, git, markdown, and execution helpers for magefiles.
Index ¶
Constants ¶
View Source
const GeneratedBanner = "<!-- Page generated by Cargoship; DO NOT EDIT -->"
GeneratedBanner marks a page as generator output.
Variables ¶
This section is empty.
Functions ¶
func CleanBuild ¶
func CleanBuild() error
CleanBuild removes compiled binary artifacts under build/.
func EscapeAngleBrackets ¶
EscapeAngleBrackets replaces literal "<" and ">" with HTML entities.
func GitCommit ¶
func GitCommit() string
GitCommit returns the short commit of the checkout being built, suffixed with "-dirty" when the working tree has uncommitted changes. When the commit cannot be resolved, it returns config.UnsetCLICommit.
func PaddedTable ¶
PaddedTable renders a table in the aligned form required by repo style guides.
func RenderYAMLValue ¶
RenderYAMLValue renders a default value the way it is written in YAML.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.