Add: git_mirror action to icktool page

1 files changed, 31 insertions, 0 deletions

diff --git a/icktool.mdwn b/icktool.mdwn
index 69fc3b7..7224f65 100644
--- a/icktool.mdwn
+++ b/icktool.mdwn
@@ -239,6 +239,37 @@ The worker manager defines (at least) the following actions:
 
     Further actions, inside a container, can do other operations.
 
+* `action: git_mirror`
+
+    This will be replacing the `git` action. It has not yet been
+    implemented. You can use the `git` action as before, for now.
+    Eventually the `git` action will be removed, after a suitable
+    transition period.
+
+    Mirror one or more git repositories specified in the `sources`
+    project variable. The parameter is expected to have as its value a
+    list of dicts, each dict containing the following fields:
+
+    * `name` — name of the repository
+    * `repo` — URL of the repository
+    * `location` — ignored by `git_mirror`, but can be used to
+      specify where the clone'd repository is to be checked out
+    * `ref` — ignored by `git_mirror`, but can be used to
+      specify which ref (branch or tag or commit) should be checked out
+
+    Additionally, `git_mirror` will use the `git_repo_base` project
+    parameter: if the `repo` field is a relative URL, it will be
+    joined with the `git_repo_base` value to form the full URL. If
+    `repo` is a full URL, it is used as is.
+
+    Note that `git_mirror` does NOT do the checking out, only the
+    initial mirroring (as if by `git clone --mirror $repo
+    .mirror/$name`) or updating of the mirror (as if  by `cd
+    .mirror/$name && git remote update --prune`).
+
+    Ick provides a pipeline that uses the `git_mirror` action and
+    addtional `shell` or `python` actions to do the checkout.
+
 * `action: rsync`
 
     Copy the content of a directory in the workspace (named in