From 546f4cd46f21561d9f39ee695fdfa6809e0d9c29 Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Tue, 5 Feb 2019 18:40:31 -0500 Subject: Add prerequisite keep_artifacts var --- deployment/README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'deployment/README.md') 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 `/pkg-dist` directory. -- cgit v1.2.3 From e1d523ee458d19ad412795b71d9dfb1c4fc7b688 Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Tue, 5 Feb 2019 21:37:56 -0500 Subject: Improve description of keep_artifacts flag --- deployment/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'deployment/README.md') diff --git a/deployment/README.md b/deployment/README.md index 608d80e58..a00cd3e6c 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -55,7 +55,7 @@ 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. +* The `clean` action can be passed a variable as argument 1, named `keep_artifacts`, containing either the value `y` or `n`. 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 -- cgit v1.2.3