aboutsummaryrefslogtreecommitdiff
path: root/deployment
diff options
context:
space:
mode:
authorJoshua Boniface <joshua@boniface.me>2019-02-05 18:40:31 -0500
committerJoshua Boniface <joshua@boniface.me>2019-02-05 18:40:31 -0500
commit546f4cd46f21561d9f39ee695fdfa6809e0d9c29 (patch)
tree09dadfe5f562c43453f16196064ff46a306e5995 /deployment
parentd351fa0c1e06862fd0cc7c68c0944ee0b8835809 (diff)
Add prerequisite keep_artifacts var
Diffstat (limited to 'deployment')
-rw-r--r--deployment/README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/deployment/README.md b/deployment/README.md
index 05b4ed51e..608d80e58 100644
--- a/deployment/README.md
+++ b/deployment/README.md
@@ -55,6 +55,8 @@ These builds are not necessarily run from the `build` script, but are present fo
* The `clean` action should always `exit 0` even if no work is done or it fails.
+* The `clean` action can be passed a variable as argument 1, named `keep_artifacts`. It is indended to handle situations when the user runs `build --keep-artifacts` and should be handled intelligently. Usually, this is used to preserve Docker images while still removing temporary directories.
+
### Output Files
* Upon completion of the defined actions, at least one output file must be created in the `<platform>/pkg-dist` directory.