Add: globs and name_from to the "archive: workspace" action

1 files changed, 18 insertions, 1 deletions

diff --git a/icktool.mdwn b/icktool.mdwn
index dc0b0df..69fc3b7 100644
--- a/icktool.mdwn
+++ b/icktool.mdwn
@@ -195,7 +195,24 @@ The worker manager defines (at least) the following actions:
 
     Take the current content of the workspace, put it in a compressed
     tar archive, and uplad it to the artifact store. Get the name of
-    the artifact from the `artifact_name` parameter.
+    the artifact from the parameter named in the `name_from` field, if
+    given, and the`artifact_name` parameter if not.
+
+    Optionally archive only parts of the workspace. User can give a
+    list of globs in the `globs` field, and anything that matches any
+    of the shell filename patterns will be included. Default is to
+    archive everything.
+
+    Example:
+
+        - archive: workspace
+          name_from: debian_packages
+          globs:
+          - "*_*"
+
+    This would archive everything at the root of the workspace with an
+    underscore in the name. The artifact will be named using the value
+    of the `debian_packages` project parameter.
 
 * `action: populate_systree`