Refactoring: remove CI_PARAM_ prefix from variables

There is no need to add a prefix to the variables. Basically every variable can be set or overridden at the trigger level, so we just use plain variable names for everything.

Refactoring: remove CI_PARAM_ prefix from variables
17b87f84 · Tim Jaacks · 825f3686 · 17b87f84 · 17b87f84 · 17b87f84
Commit 17b87f84 authored Sep 4, 2023 by Tim Jaacks
--- a/build-pipeline-yocto.yml.jinja2
+++ b/build-pipeline-yocto.yml.jinja2
@@ -37,8 +37,8 @@ changelog:
 # --------------------------------------------------------------------------------------
 # Generated jobs
 # --------------------------------------------------------------------------------------
-{% if CI_PARAM_MACHINES %}
-{% for machine in CI_PARAM_MACHINES.split(' ') %}
+{% if MACHINES %}
+{% for machine in MACHINES.split(' ') %}

 # --------------------------------------------------------------------------------------
 # Stage: Build
@@ -49,7 +49,7 @@ build-{{ machine }}:
  extends: .build_yocto
  variables:
    BITBAKE_TASK: build
-    CI_PARAM_MACHINE: {{ machine }}
+    MACHINE: {{ machine }}

 {% else %}

@@ -103,11 +103,11 @@ smoketest:{{ machine }}:
  needs:
    - job: build-{{ machine }}
  variables:
-    CI_PARAM_BUILDJOB: build-{{ machine }}
-    CI_PARAM_MACHINE: {{ lavamachine }}
-    CI_PARAM_PLATFORMS: {{ lavamachine }}
-    CI_PARAM_TEST_SUITE: boot.jinja2
-    CI_PARAM_EXTRA: --all-devices
+    BUILD_JOB: build-{{ machine }}
+    MACHINE: {{ lavamachine }}
+    PLATFORMS: {{ lavamachine }}
+    TEST_SUITE: boot.jinja2
+    TEST_EXTRA_ARGUMENTS: --all-devices

 platformtest:{{ machine }}:
  extends:
@@ -116,9 +116,9 @@ platformtest:{{ machine }}:
  needs:
    - job: build-{{ machine }}
  variables:
-    CI_PARAM_BUILDJOB: build-{{ machine }}
-    CI_PARAM_MACHINE: {{ lavamachine }}
-    CI_PARAM_PLATFORMS: {{ platforms }}
+    BUILD_JOB: build-{{ machine }}
+    MACHINE: {{ lavamachine }}
+    PLATFORMS: {{ platforms }}
 {% endif %}


@@ -258,4 +258,4 @@ publish-confluence-page:
 {% endif %}
 {% endif %}

-{% endif %} # if CI_PARAM_MACHINES
+{% endif %} # if MACHINES
--- a/build-pipeline.yml
+++ b/build-pipeline.yml
@@ -98,17 +98,17 @@ workflow:

 .build_script: &build_script
  # setup build environment
-  - echo "${LOG_PREFIX} Build configuration MACHINE=${CI_PARAM_MACHINE}
-      DISTRO=${CI_PARAM_DISTRO} IMAGE=${CI_PARAM_IMAGE}"
+  - echo "${LOG_PREFIX} Build configuration MACHINE=${MACHINE}
+      DISTRO=${YOCTO_DISTRO} IMAGE=${YOCTO_IMAGE}"
  - echo "${LOG_PREFIX} Using build dir ${BUILD_PATH}"
-  - export MACHINE="${CI_PARAM_MACHINE}"
-  - export DISTRO="${CI_PARAM_DISTRO}"
+  - export MACHINE="${MACHINE}"
+  - export DISTRO="${YOCTO_DISTRO}"
  - export EULA="1"
  - source ./"${SETUP_SCRIPT}" "${BUILD_PATH}"
  # start build
  - echo -e "section_start:`date +%s`:bitbake_run\r\e[0KBitbake Log"
-  - echo "${LOG_PREFIX} bitbake ${CI_PARAM_IMAGE} -c ${BITBAKE_TASK}"
-  - bitbake "${CI_PARAM_IMAGE}" -c "${BITBAKE_TASK}"
+  - echo "${LOG_PREFIX} bitbake ${YOCTO_IMAGE} -c ${BITBAKE_TASK}"
+  - bitbake "${YOCTO_IMAGE}" -c "${BITBAKE_TASK}"
  - echo -e "section_end:`date +%s`:bitbake_run\r\e[0K"

 .save_build_env: &save_build_env
@@ -211,8 +211,8 @@ workflow:
    GIT_STRATEGY: none
    SETUP_SCRIPT: "setup-environment"
    LOG_PREFIX: "CI:build:"
-    BUILD_PATH: "build-${CI_PARAM_DISTRO}-${CI_PARAM_MACHINE}"
-    IMAGE_PATH: "${BUILD_PATH}/tmp/deploy/images/${CI_PARAM_MACHINE}"
+    BUILD_PATH: "build-${YOCTO_DISTRO}-${MACHINE}"
+    IMAGE_PATH: "${BUILD_PATH}/tmp/deploy/images/${MACHINE}"
    LICENSES_PATH: "${BUILD_PATH}/tmp/deploy/licenses"
    SDK_PATH: "${BUILD_PATH}/tmp/deploy/sdk"
    JOB_URL: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/jobs/${CI_JOB_ID}"
@@ -243,8 +243,8 @@ workflow:
    # TODO checkout only gitlab-ci repo to allow running on deleted branches
    # Include git submodules
    GIT_SUBMODULE_STRATEGY: recursive
-    CI_PARAM_TEST_SUITE: '{platform}.jinja2'
-    CI_PARAM_EXTRA: --nop
+    TEST_SUITE: '{platform}.jinja2'
+    TEST_EXTRA_ARGUMENTS: --nop
    GITLAB_SERVER: "${CI_SERVER_HOST}:${CI_SERVER_SSH_PORT}"
    GIT_BASE_URL: "ssh://git@${GITLAB_SERVER}/${CI_PROJECT_ROOT_NAMESPACE}"
    TESTS_GIT_URL: "${GIT_BASE_URL}/yocto/tests.git"
@@ -262,7 +262,7 @@ workflow:
        --project $CI_PROJECT_ID
        --pipeline $CI_PIPELINE_ID
        --token=$GITBOT_TOKEN
-        --name $CI_PARAM_BUILDJOB
+        --name $BUILD_JOB
        --path build.env
    - cat build.env
    - source build.env
@@ -270,14 +270,14 @@ workflow:
    - .gitlab-ci/scripts/submit_test.py
        --fng-install "$FNG_INSTALL_URL"
        --name
-        "Gitlab $CI_PARAM_MACHINE $CI_PARAM_DISTRO $CI_PARAM_IMAGE ($CI_PIPELINE_ID)"
+        "Gitlab $MACHINE $YOCTO_DISTRO $YOCTO_IMAGE ($CI_PIPELINE_ID)"
        --results-path "results"
        --report-name "testresults-${CI_JOB_NAME}.md"
        --test-repo $TESTS_GIT_URL
        --test-repo-branch $TEST_REPO_BRANCH
-        --test-plan $CI_PARAM_TEST_SUITE
-        $CI_PARAM_EXTRA
-        $CI_PARAM_PLATFORMS
+        --test-plan $TEST_SUITE
+        $TEST_EXTRA_ARGUMENTS
+        $PLATFORMS

 # --------------------------------------------------------------------------------------
 # Stage: package

--- a/manifest-pipeline-ci-test.yml
+++ b/manifest-pipeline-ci-test.yml
@@ -11,7 +11,7 @@ variables:
  # In the manifest, the remotes are specified by an identifier. This is used to find
  # out included projects for the retrigger job. In custom manifests, the remote may be
  # named differently, so we need a variable that may be overriden.
-  CI_PARAM_SECO_REMOTE: ci-test
+  SECO_REMOTE: ci-test

  # GitLab group to search for projects to retrigger
  RETRIGGER_GROUP: ${CI_PROJECT_ROOT_NAMESPACE}/yocto/infrastructure/ci-test
@@ -28,7 +28,7 @@ variables:
    seco-ne/yocto/infrastructure/ci-test/minimal-foo

  # List of machines to simulate building images for
-  CI_PARAM_MACHINES: seco-mx6 seco-mx8mm
+  MACHINES: seco-mx6 seco-mx8mm

 .yocto-deploy:
  variables:
@@ -70,8 +70,8 @@ yocto-simulation-pipeline:
  variables:
    BUILD_ARTIFACTS_PREFIX: >-
      https://git.seco.com/seco-ne/yocto/manifest/-/jobs/artifacts/kirkstone/7.0/download?job=build
-    CI_PARAM_IMAGE: seconorth-image
-    CI_PARAM_DISTRO: seconorth-wayland
+    YOCTO_IMAGE: seconorth-image
+    YOCTO_DISTRO: seconorth-wayland
    INSTALL_SCRIPT: fng-install.sh
    ARTIFACTS_PATH: build-*/tmp/deploy/images/**/*
    PACKAGE_TYPE: image
@@ -90,8 +90,8 @@ sdk-simulation-pipeline:
  variables:
    BUILD_ARTIFACTS_PREFIX: >-
      https://git.seco.com/seco-ne/yocto/manifest/-/jobs/artifacts/kirkstone/7.0/download?job=buildsdk
-    CI_PARAM_IMAGE: seconorth-image
-    CI_PARAM_DISTRO: seconorth-wayland
+    YOCTO_IMAGE: seconorth-image
+    YOCTO_DISTRO: seconorth-wayland
    INSTALL_SCRIPT: fng-install.sh
    ARTIFACTS_PATH: build-*/tmp/deploy/sdk/*
    MANUAL_BUILD: "true"

--- a/manifest-pipeline-yocto.yml
+++ b/manifest-pipeline-yocto.yml
@@ -11,7 +11,7 @@ variables:
  # In the manifest, the remotes are specified by an identifier. This is used to find
  # out included projects for the retrigger job. In custom manifests, the remote may be
  # named differently, so we need a variable that may be overriden.
-  CI_PARAM_SECO_REMOTE: seco-ne
+  SECO_REMOTE: seco-ne

  # GitLab group to search for projects to retrigger
  RETRIGGER_GROUP: ${CI_PROJECT_ROOT_NAMESPACE}
@@ -24,7 +24,7 @@ variables:
    seco-ne/yocto/layers/meta-seconorth-machine

  # List of machines to build images for
-  CI_PARAM_MACHINES: imx6guf imx6ullguf imx8mguf imx8mpguf
+  MACHINES: imx6guf imx6ullguf imx8mguf imx8mpguf

 .yocto-deploy:
  variables:
@@ -65,8 +65,8 @@ yocto-pipeline:
    - .yocto-deploy
  variables:
    BITBAKE_TASK: build
-    CI_PARAM_IMAGE: guf-image
-    CI_PARAM_DISTRO: guf-wayland
+    YOCTO_IMAGE: guf-image
+    YOCTO_DISTRO: guf-wayland
    INSTALL_SCRIPT: fng-install.sh
    ARTIFACTS_PATH: build-*/tmp/deploy/images/**/*
    PACKAGE_TYPE: image
@@ -81,8 +81,8 @@ sdk-pipeline:
    - .yocto-deploy
  variables:
    BITBAKE_TASK: populate_sdk
-    CI_PARAM_IMAGE: guf-image
-    CI_PARAM_DISTRO: guf-wayland
+    YOCTO_IMAGE: guf-image
+    YOCTO_DISTRO: guf-wayland
    ARTIFACTS_PATH: build-*/tmp/deploy/sdk/*
    MANUAL_BUILD: "true"
    PACKAGE_TYPE: sdk
@@ -93,8 +93,8 @@ fngsystem-pipeline:
    - .fngsystem-deploy
  variables:
    BITBAKE_TASK: build
-    CI_PARAM_IMAGE: fngsystem-image
-    CI_PARAM_DISTRO: guf-fngsystem
+    YOCTO_IMAGE: fngsystem-image
+    YOCTO_DISTRO: guf-fngsystem
    INSTALL_SCRIPT: fngsystem-self-update.sh
    ARTIFACTS_PATH: build-*/tmp/deploy/images/**/*
    PACKAGE_TYPE: image