DD44: add section on running CI jobs locally

1 files changed, 25 insertions, 0 deletions

diff --git a/design-documents/044-ci-system.rst b/design-documents/044-ci-system.rst
index 7e5a8b7b..f8dcbd6d 100644
--- a/design-documents/044-ci-system.rst
+++ b/design-documents/044-ci-system.rst
@@ -87,6 +87,31 @@ by default.
 
 All projects SHOULD have a ``build`` step and a ``test`` step, at a minimum.
 
+Running CI Locally
+------------------
+
+Running the CI scripts locally can be useful for development and testing.
+
+*Be aware that custom configs for a given job may specify a alternate
+container.*
+
+
+Example of building the environment and running a job locally:
+
+::
+
+  # From root of repo directory, build the container:
+  docker build -t <local_name_for_container> -f ci/Containerfile .  # <- don't forget the "."
+
+  # Then to run one of the job scripts. For example:
+  docker run --rm --volume $PWD:/workdir --workdir /workdir <local_name_for_container> ci/jobs/1-build/job.sh
+
+  # or to get an interactive shell in the container, with the repo mounted at /workdir:
+  docker run -ti --rm --volume $PWD:/workdir --workdir /workdir <local_name_for_container> /bin/bash
+
+
+
+
 Additional Builders
 -------------------