[taler-docs] branch master updated (6bb9dd78 -> ac949430)

[gnunet]

This is an automated email from the git hooks/post-receive script.

devan-carpenter pushed a change to branch master
in repository docs.

    from 6bb9dd78 small changes
     new 57a78d71 DD44: update path references
     new ac949430 DD44: document using script to run jobs local

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 design-documents/044-ci-system.rst | 72 ++++++++++++++++++++++----------------
 1 file changed, 41 insertions(+), 31 deletions(-)

diff --git a/design-documents/044-ci-system.rst 
b/design-documents/044-ci-system.rst
index e777f345..cfb733aa 100644
--- a/design-documents/044-ci-system.rst
+++ b/design-documents/044-ci-system.rst
@@ -43,23 +43,24 @@ Example directory structure:
 
 ::
 
-  ci
-  ├── ci.sh
-  ├── Containerfile
-  └── jobs
-      ├── 0-codespell
-      │   ├── config.ini
-      │   ├── dictionary.txt
-      │   └── job.sh
-      ├── 1-build
-      │   ├── build.sh
-      │   └── job.sh
-      └── 2-docs
-          ├── docs.sh
-          └── job.sh
+  contrib
+  └── ci
+      ├── ci.sh
+      ├── Containerfile
+      └── jobs
+          ├── 0-codespell
+          │   ├── config.ini
+          │   ├── dictionary.txt
+          │   └── job.sh
+          ├── 1-build
+          │   ├── build.sh
+          │   └── job.sh
+          └── 2-docs
+              ├── docs.sh
+              └── job.sh
   
 Job directories **MUST** follow this pattern: 
-``<repo_root>/ci/jobs/<n-job_name>/``
+``<repo_root>/contrib/ci/jobs/<n-job_name>/``
 
 ``n`` is an integer used for ordering the build steps.
 
@@ -78,10 +79,11 @@ Available config options:
   WARN_ON_FAILURE = True|False
   CONTAINER_BUILD = True|False
   CONTAINER_NAME = <string>
+  CONTAINER_ARCH = <string>
 
 
 Unless *all* jobs specify a "CONTAINER_NAME" in their custom config a
-container file **MUST** be present at ``<repo_root>/ci/Containerfile``.
+container file **MUST** be present at ``<repo_root>/contrib/ci/Containerfile``.
 The container file will be built and used to run all of a repo's jobs 
 by default.
 
@@ -92,24 +94,32 @@ 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:
+Included in each CI directory is a script which simplifies running jobs
+in the same way the CI Worker does, in containers, using either `podman`
+or `docker`, detecting if you have either installed.
 
 ::
 
-  # 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
-
-
+  # Usage:
+  ./contrib/ci/ci.sh <job-name>
+
+  # For example, if the CI jobs tree looks like this:
+  ./contrib/ci/jobs
+    ├── 0-codespell/
+    ├── 1-build/
+    ├── 2-test/
+    ├── 3-docs/
+    ├── 4-deb-package/
+    └── 5-deploy-package/
+
+  # Then you can run job '0-codespell' as follows:
+  ./contrib/ci/ci.sh 0-codespell
+
+  # If you are using podman and have "qemu-user-binfmt" installed
+  # then you may attempt to run any job under an alternative CPU
+  # architecture by providing a second argument.
+  # For example:
+  ./contrib/ci/ci.sh 0-codespell arm64
 
 
 Additional Builders

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.