aboutsummaryrefslogtreecommitdiff
path: root/acid.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'acid.adoc')
-rw-r--r--acid.adoc18
1 files changed, 16 insertions, 2 deletions
diff --git a/acid.adoc b/acid.adoc
index ff5d69b..b60cc80 100644
--- a/acid.adoc
+++ b/acid.adoc
@@ -37,6 +37,8 @@ Commands
*restart* [_ID_]...::
Schedule tasks with the given IDs to be rerun.
Run this command without arguments to pick up external database changes.
+*reload*::
+ Reload configuration.
Configuration
-------------
@@ -45,7 +47,7 @@ file present in the distribution.
All paths are currently relative to the directory you launch *acid* from.
-The *notify*, *setup*, and *build* scripts are processed using Go's
+The *notify*, *setup*, *build*, and *deploy* scripts are processed using Go's
_text/template_ package, and take an object describing the task,
which has the following fields:
@@ -65,6 +67,17 @@ which has the following fields:
*RunnerName*::
Descriptive name of the runner.
+// Intentionally not documenting CreatedUnix, ChangedUnix, DurationSeconds,
+// which can be derived from the objects.
+*Created*, *Changed*::
+ `*time.Time` of task creation and last task state change respectively,
+ or nil if not known.
+*CreatedAgo*, *ChangedAgo*::
+ Abbreviated human-friendly relative elapsed time duration
+ since *Created* and *Changed* respectively.
+*Duration*::
+ `*time.Duration` of the last run in seconds, or nil if not known.
+
*URL*::
*acid* link to the task, where its log output can be seen.
*RepoURL*::
@@ -79,7 +92,8 @@ in *sh*(1) command arguments.
Runners
-------
-Runners receive the following additional environment variables:
+Runners and deploy scripts receive the following additional
+environment variables:
*ACID_ROOT*:: The same as the base directory for configuration.
*ACID_RUNNER*:: The same as *Runner* in script templates.