Pipeline Configuration

Pipeline Configuration

EmbedOps images that execute the pipeline stages (e.g. build, quality, test) use CI/CD provider repository variables, environment variables and settings from EmbedOps YAML Config files.

In general, any setting that is required for a given pipeline stage to function properly will be included in your pipeline YAML template when configuring your pipeline in the EmbedOps Web UI or communicated to you directly when your project is onboarded to the platform.

What Is An EmbedOps YAML Config File?

EmbedOps YAML Config files are YAML files that are distinct from pipeline YAML files (e.g. .gitlab-ci.yml , bitbucket-pipelines.yml ). EmbedOps YAML Config files contain configuration settings that are available across all CI/CD pipeline stages. There is one main EmbedOps YAML Config file and other EmbedOps YAML Config files that configure specific EmbedOps docker images for pipeline stages such as cppcheck .

All EmbedOps YAML Config files must exist under the .embedops/  directory in the root of the project repository. 

EmbedOps Main YAML Config

Each EmbedOps pipeline stage inspects the EmbedOps Main YAML Config file for settings and pipeline environment variable overrides. Any setting that exists in this config file is, essentially, an override to a repository or pipeline environment variable, but can include custom variables needed for project-specific use cases. The EmbedOps Main YAML Config file must exist at <repo_root>/.embedops/config.yml .

Built-In Variables

Some of the variables outlined in the table, below, are not typically seen in CI/CD providers such as Bitbucket or Gitlab, but are useful in embedded systems projects. These variables can be set as repository or pipeline environment variables depending on the desired scope of the variable, and come with hard-coded defaults if not defined as a repository, environment or EmbedOps Main YAML Config variable.

Variable Definition And Override Precedence

For each configuration setting, there are several ways to define and override them. Most CI/CD pipeline providers have their own methods for defining environment variables that get injected to the pipeline run-time environment such as repository, pipeline, group, deployment, etc. variables and they also have their own order of precedence with regards to how one overrides the other.

For EmbedOps YAML Config files, the order of precedence from highest to lowest for these variables is as follows:

1. Settings in the EmbedOps YAML Config file (<repo_root>/.embedops/config.yml )
2. Any repository or pipeline environment variable
3. Hardcoded defaults

Example A

Example B

Example C

Example Main Config File

# <repo_root>/.embedops/config.yml
---
PROJECT_NAME: ExampleProject
PREPROCESSOR_SYMBOL: STM32L476xx
SRC_DIR: embedded_src

Expansion Variables in YAML Config Files

If present, any GNU Shell/Bash style variable present in any <repo_root>/.embedops/**/config.yml file will be replaced with the corresponding value.

For example, if you have a repository variable MY_PROJECT_VARIABLE = abc123 and <repo_root>/.embedops/config.yml file with:

# <repo_root>/.embedops/config.yml
---
PROJECT_NAME: $MY_PROJECT_VARIABLE

The PROJECT_NAME for all pipeline stages will be abc123 .

EmbedOps Cppcheck YAML Config

EmbedOps will parse the file <repo_root>/.embedops/cppcheck/config.yml  and run cppcheck according to these settings. Then the results of the cppcheck  analysis will be printed to the pipeline console.

CPPCHECK_CMAKE_TARGETS:
    - ARGS: -B build/stm/debug -DCMAKE_TOOLCHAIN_FILE=toolchain/cross/stm32l152xc.cmake -DCMAKE_BUILD_TYPE=Debug .
      BUILD_DIR: build/stm/debug<br>
		

Example Cppcheck Config File

# <repo_root>/.embedops/cppcheck/config.yml
---
CPPCHECK_JOB_NAME: cppcheck-2.8
CPPCHECK_INFORMATION_THRESHOLD: 5
CPPCHECK_PORTABILITY_THRESHOLD: 0
CPPCHECK_PERFORMANCE_THRESHOLD: 0
CPPCHECK_STYLE_THRESHOLD: 120
CPPCHECK_WARNINGS_THRESHOLD: 2
CPPCHECK_ERRORS_THRESHOLD: 1
CPPCHECK_OUTPUT_DIR: cppcheckReport
CPPCHECK_RELATIVE_PATHS:
  - ${SRC_DIR}/Src
  - ${SRC_DIR}/tests
CPPCHECK_INCLUDES:
  - ${SRC_DIR}/Include
  - ${SRC_DIR}/LoRaWAN/Inc
  - ${SRC_DIR}/FreeRTOS
  - ${SRC_DIR}/FreeRTOS/Source/include
CPPCHECK_SUPRESSES:
  - unusedFunction
  - preprocessorErrorDirective:${SRC_DIR}/Src/main.h:31

EmbedOps Googletest YAML Config

EmbedOps will parse the file  <repo_root>/.embedops/googletest/config.yml  and run the tests according to these settings. Then the test results will be printed to the pipeline console.

Example Googletest Config File

# <repo_root>/.embedops/googletest/config.yml
---
GOOGLETEST_JOB_NAME: ${EMBEDOPS_JOB_NAME}
GOOGLETEST_BUILD_COMMAND: test/build_and_test.sh
GOOGLETEST_DIRECTORY: src

EmbedOps IAR YAML Config

EmbedOps will parse the file   <repo_root>/.embedops/iar/config.yml  and configure IAR tools according to these settings.

IAR_BUILD_TARGETS:
  - PROJECT_FILE: arm/componentA.ewp
    CONFIGURATION: Debug

Example IAR Config File

# <repo_root>/.embedops/iar/config.yml
---
IAR_BUILD_TARGETS:
  - PROJECT_FILE: arm/componentA.ewp
    CONFIGURATION: Debug

EmbedOps Administrative YAML Configs

Administrative configs are intended solely for EmbedOps usage. These configs should never be edited by EmbedOps users unless instructed to do so by an EmbedOps Admin.

Repository Identifier