From 30683cd2acee1812d1bf308ec75bffb8d2231924 Mon Sep 17 00:00:00 2001 From: Jim Van Fleet Date: Wed, 27 Jul 2016 11:01:30 -0400 Subject: [PATCH] Adding common.bash documentation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index a61b09d..c25c1ff 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,15 @@ To use these scripts on your container image construction project, issue these c ``` ``` +### common.bash + +The installation process will create a common.bash file. This file should be the central, canonical authority for management of environment variables. While a subprocess may override them, the files in common.bash should be treated as authoritative defaults. Processes (e.g. `docker build`, `bats`, inside `Jenkinsfile`) can read this file and process the results therein. + +You should edit this file to change the image name, and add any other helpful environment variables. + ## Use + ### Building #### build.sh