Updated comments and references in CI config.

.ahoy.yml

@@ -10,13 +10,11 @@
 # Run `ahoy up cli` to apply environment variables changes to containers.
 #;
 #; Comments starting with '#:' provide explicit documentation and will be
-#; automatically removed during installation or update if an option is selected.
+#; automatically removed during installation or update of DrevOps if an option
+#; is selected.
 #;
-#; Comments starting with '#;<', '#;>' and '#;' are internal DrevOps comments
-#; and will be removed during installation or update.
-#;
-#; Comments starting with '#' are normal comments and will stay in the code
-#; after installation or update.
+#; Comments starting with '#;<' and '#;>' are internal DrevOps comments
+#; and will be removed during installation or update of DrevOps.
 ---
 ahoyapi: v2
 

.circleci/config.yml

@@ -6,17 +6,20 @@
 #: run commands defined in this file. Application Docker containers defined in
 #: docker-compose.yml run on a *remote* Docker server controlled by CircleCI.
 #: The "runner" container uses Docker client to control the remote Docker server.
-#:
-#: Comments starting with '#;', '#;<' or '#;>' (like the ones used for the
-#: current paragraph) are explaining DrevOps inner workings and can be safely
-#: removed for your project. They are automatically removed when installing or
-#: updating DrevOps.
+#;
+#; Comments starting with '#:' provide explicit documentation and will be
+#; automatically removed during installation or update of DrevOps if an option
+#; is selected.
+#;
+#; Comments starting with '#;<' and '#;>' are internal DrevOps comments
+#; and will be removed during installation or update of DrevOps.
 version: '2.1'
 
-#:###############################################################################
-#: VARIABLES
-#:###############################################################################
+################################################################################
+# VARIABLES
+################################################################################
 #: For YAML support of anchors and references, see http://blog.daemonl.com/2016/02/yaml.html
+
 aliases:
   #-----------------------------------------------------------------------------
   # Per-project variables.
@@ -116,8 +119,8 @@ aliases:
 
   #:-----------------------------------------------------------------------------
 
-  #: Shared configuration applied to each job.
-  - &container_config
+  #: Shared runner container configuration applied to each job.
+  - &runner_config
     #: Location of the checked-out files within the "runner" container.
     working_directory: &working_directory /root/project
     environment:
@@ -126,8 +129,8 @@ aliases:
       #;> !PROVISION_USE_PROFILE
       DREVOPS_DEPLOY_SSH_FINGERPRINT: *deploy_ssh_fingerprint
     docker:
-      # Using "runner" container where each job will be executed.
-      # This container has all necessary tools to run dockerized environment.
+      # Using the 'runner' container where each job will be executed.
+      # This container has all the necessary tools to run a dockerized environment.
       # @see https://github.com/drevops/ci-runner
       # @see https://hub.docker.com/repository/docker/drevops/ci-runner/tags?page=1&ordering=last_updated
       - image: drevops/ci-runner:23.12.0
@@ -179,9 +182,10 @@ aliases:
       name: Process codebase to run in CI
       command: find . -name "docker-compose.yml" -print0 | xargs -0 -I {} sh -c "sed -i -e ''/###/d'' {} && sed -i -e ''s/##//'' {}"
 
-#:###############################################################################
-#: JOBS
-#:###############################################################################
+################################################################################
+# JOBS
+################################################################################
+
 jobs:
   #;< !PROVISION_USE_PROFILE
   #: Database handling is a first step of the build.
@@ -194,7 +198,7 @@ jobs:
   #: This allows to rely on the cache from the previous days within the same
   #: branch.
   database: &job_database
-    <<: *container_config
+    <<: *runner_config
     steps:
       - attach_workspace:
           at: /workspace
@@ -281,7 +285,7 @@ jobs:
   # Build and test is a second step of the build. The testing is performed
   # within the same job to save time on provisioning during the job.
   build: &job_build
-    <<: *container_config
+    <<: *runner_config
     parallelism: *parallelism
     steps:
       - attach_workspace:
@@ -364,7 +368,7 @@ jobs:
   #;< DEPLOYMENT
   # Deploy primary branches.
   deploy: &job_deploy
-    <<: *container_config
+    <<: *runner_config
     steps:
       - attach_workspace:
           at: /workspace
@@ -385,7 +389,7 @@ jobs:
 
   # Deploy tags.
   deploy_tags: &job_deploy_tags
-    <<: *container_config
+    <<: *runner_config
     steps:
       - attach_workspace:
           at: /workspace
@@ -436,7 +440,7 @@ jobs:
   # Test suite for DrevOps.
   #-----------------------------------------------------------------------------
   drevops_dev_test:
-    <<: *container_config
+    <<: *runner_config
     parallelism: 1
     steps:
       - checkout
@@ -459,7 +463,7 @@ jobs:
           command: codecov -Z -s /tmp/artifacts/coverage
 
   drevops_dev_test_workflow:
-    <<: *container_config
+    <<: *runner_config
     parallelism: 3
     resource_class: large
     steps:
@@ -480,7 +484,7 @@ jobs:
           command: codecov -Z -s /tmp/artifacts/coverage
 
   drevops_dev_test_deployment:
-    <<: *container_config
+    <<: *runner_config
     parallelism: 2
     steps:
       - checkout
@@ -506,7 +510,7 @@ jobs:
 
   # Run tests after 'build' job.
   drevops_dev_test_postbuild:
-    <<: *container_config
+    <<: *runner_config
     parallelism: 1
     steps:
       - checkout
@@ -617,7 +621,7 @@ jobs:
   # @todo Move this to GitHub Actions.
   #-----------------------------------------------------------------------------
   drevops_dev_deploy_docs:
-    <<: *container_config
+    <<: *runner_config
     steps:
       - checkout
       - *step_process_codebase
@@ -651,7 +655,7 @@ jobs:
   # @todo Move this to GitHub Actions.
   #-----------------------------------------------------------------------------
   drevops_dev_deploy_installer:
-    <<: *container_config
+    <<: *runner_config
     steps:
       - checkout
       - *step_process_codebase
@@ -699,9 +703,10 @@ jobs:
   #=============================================================================
   #;> DREVOPS_DEV
 
-#:###############################################################################
-#: WORKFLOWS
-#:###############################################################################
+################################################################################
+# WORKFLOWS
+################################################################################
+
 workflows:
   version: 2
   # Commit workflow. Runs for every commit push to the remote repository.