Pipeline Stage & Step Reference
Pipeline stage reference
A pipeline stage is like a milestone which contains one or more pipeline steps. Each stage has a Type attribute, which impacts the supported pipeline steps. There are 3 types of stages, which are listed below.
| Stage Type | Supported Steps | Description |
|---|---|---|
| Development | Snapshot, Checkstyle, Test, Script | The stage is associated with the Workflow PC, where users can run Snapshot, Checkstyle, Test, and Script. When you define the Development stage, you need to select the BAW server, ProcessApp, and Snapshot. The snapshot can be overridden if there is a Snapshot step in this Stage, or users specify another snapshot when running the pipeline. If it is not overridden, this snapshot will be used for Checkstyle, Test, and Deployment. |
| Test, Stage, Production | Checkstyle, Test, Script | The stage is associated with the Workflow PS, where users can run Checkstyle, Test, and Script. Please note that the Snapshot step can only be run from the Development stage. If it is the first stage in the pipeline, it means there is no associated PC environment; thus, no new snapshot will be created during the pipeline execution. So when you run the pipeline, you need to specify an existing snapshot name to execute Checkstyle, Test, and Deployment steps. |
| Utility | Script | The stage is not associated with a Workflow environment. It is associated with the IDA server, on which you can run the Script step. |
Pipeline step reference
| Step Name | Parameters | Description |
|---|---|---|
| Snapshot | Naming Pattern: the naming pattern for the created snapshot. | The Snapshot step is used to create a snapshot by the specified naming pattern. This step is only available in the Workflow DEV environment. |
| Checkstyle | Health Score Threshold: the threshold to define the health score. If Halt On Failure is checked and the health score exceeds the threshold, the checkstyle step is considered failed, and the pipeline is stopped. Warnings Threshold: the threshold for the number of warnings. If Halt On Failure is checked and the number of warnings exceeds the threshold, the checkstyle step is considered failed, and the pipeline is stopped. Ignore Empty Documentation: indicates whether to ignore empty documentation. Ignore JS Coding Style Check: indicates whether to ignore JS coding style check. Halt On Failure: indicates whether to stop the pipeline if the checkstyle result exceeds the threshold. Tip: indicates whether to run the checkstyle against the TIP snapshot. |
The Checkstyle step is used to run the checkstyle against a processApp. |
| Test | Project: the test project to run. Tip: indicates whether to run the test against the TIP snapshot. Include by labels: indicates whether to include test cases by their labels. Once selected, all the test cases in the test project will be listed. User can select multiple labels in the select box shown below. Test cases must have all of the selected labels to be included in the test execution. Exclude test cases: indicates whether to exclude test cases. Once selected, all the test cases in the test project will be listed. User can select one or more test cases that will be excluded from the test execution. Halt On Failure: indicates whether to stop the pipeline if there are test case failures. |
The Test step is used to run the testing project. |
| Deployment | Synchronize Settings From Default Snapshot: select Environment Variables, EPVs, and Team Bindings to synchronize to the snapshot from the current default snapshot on the process server. Ignore Validation Error: indicates whether to ignore validation errors during deployment. Migrate Instances: Migrate process application instances from the default snapshot. Migrate process application instances from the default snapshot. If Default Policy is selected, IDA will use the default migration policy. If Custom Policy is selected, IDA will try to download the migration policy from Workflow Center. If the migration policy does not exist, IDA will pause the build until the migration policy is created on Workflow Center (supported on BAW v22.x+). Clean Old Snapshots: Clean the old snapshots without any running instances or completed tasks referenced by running instances, and the completed instances in the snapshots will be deleted as well. Offline Install : indicates it is an offline deployment. Deploy From Local File System Of Process Server: check when the installation package on the process server directory is configured on BAW Deployment Remote Dir. Online Install : indicates it is an online deployment. |
The Deployment step is used to deploy the processApp snapshot to the process server, either through online or offline deployment. The step is only available in the Workflow non-DEV environment (QA, STG, PROD). |
| Script | Script: the script content to execute | The Script step is used to run a script on the IDA server. Refer to this for more details about pipeline Script samples. |