about summary refs log tree commit diff
path: root/docs/templates.md
diff options
context:
space:
mode:
authornoqcks <benny@noqcks.io>2018-03-29T17·12-0400
committerVincent Ambo <github@tazj.in>2018-03-29T18·05+0200
commite1c2c19330911d9e35b03b8b08681e0a7cd0cb70 (patch)
treeec4806e58399fb34eb94a0b618dcdc8b03564d97 /docs/templates.md
parent867f40307e9038406625bccf8047f627dd7cb148 (diff)
feat(templater) Add a template function to insert surrounding repo's Git hash
A template function has been added that allows one to template the
Git hash of the surrounding repo. This is useful to be able to inspect the
deployment revision of an object in Kubernetes.
Diffstat (limited to 'docs/templates.md')
-rw-r--r--docs/templates.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/templates.md b/docs/templates.md
index 11488f573a59..6c44035d0967 100644
--- a/docs/templates.md
+++ b/docs/templates.md
@@ -75,6 +75,7 @@ Some template functions come from Go's standard library and are listed in the
 available in kontemplate, as well as three custom functions:
 
 * `json`: Encodes any supplied data structure as JSON.
+* `gitHEAD`: Retrieves the commit hash at Git `HEAD`.
 * `passLookup`: Looks up the supplied key in [pass][].
 * `insertFile`: Insert the contents of the given file in the resource
   set folder as a string.
@@ -96,6 +97,9 @@ certKeyPath: my-website/cert-key
 
 {{ .certKeyPath | passLookup }}
 -> Returns content of 'my-website/cert-key' from pass
+
+{{ gitHEAD }}
+-> Returns the Git commit hash at HEAD.
 ```
 
 ## Conditionals & ranges