How To: Create a YAML Pipeline Mapping

Owned by Aruna Pattabiraman (Unlicensed)
Apr 12, 2022
2 min read

Creating a Pipeline mapping is essential for yaml-based pipelines (Github Actions/Gitlab Runners), in order to associate each step to custom/specific tags, and define step names for better visualizations.

 

To start with, navigate to Settings → Data Mappings → Pipeline Data Mapping.

Click on ‘+New Pipeline Data Mapping’.

 

It opens up to few fields that aids in associating to yaml scripts and forms a pipeline.

  1. Name: Provide the name defined in the yaml script.

2. External ID: Each Action Workflow has a unique ID, and this can be retrieved through the URLs/metadata from Github events.

3. Steps: User can create multiple steps(jobs) within each mapping. This defines the various stages of the pipeline. User can add multiple steps by selecting ‘+Add Step’ .

a. Name: Job name defined within jobs. In the following example, name would be build.

b. Type: Define what type of step it is from the list of options. (Build/Scan/Deploy)

c. Environments: Provide any environmental variables defined in the yaml. This will be a key-value pair. In the above example, Key: JOBENV and Value: build-e1

4. Tags: The entire pipeline mapping can be associated to predefined set of tags. To create a tag, please refer to the Tag Management Documentation.

(ToDo: tag management documentation)

Â