Integrate with other CI CD Tools with Trigger Pipeline Connector - OutSystems/outsystems-pipeline GitHub Wiki

Trigger Pipeline Connector

Welcome to the documentation for the latest feature of the LifeTime Pipeline Trigger Plugin: the Trigger Pipeline Connector. This addition empowers you to customize CI/CD pipeline triggers according to your preferred tool, be it GitLab Pipelines, GitHub Actions, GoCD, or any other CI/CD solution.

1. Introduction

The Trigger Pipeline Connector enhances your CI/CD pipeline triggering options. Regardless of your chosen CI/CD tool, this approach allows you to customize the API calls for triggering your pipelines.

2. Customize API

2.1 Clone the TriggerPipelineConnector Module

To customize the API call that will be made to your CI/CD tool, clone the TriggerPipelineConnector module and customize the TriggerPipelineServer server action to implement the logic of the API call that will be made to your CI/CD tool.

image

3. Configure the Trigger Pipeline LifeTime Plugin

Use the following steps to set up your custom Connector in the Trigger plugin module.

3.1 Get the API Key from your custom Connector module

To obtain the API Key, access the Site Properties tab and retrieve the APIKey value.

3.2 Configure TriggerPipeline module

3.2.1 Site Properties Configuration

Access the Site Properties tab and set the ConnectorAPIKey with the APIKey value.

3.2.2 Integration configuration

Access the integrations tab and configure the following REST API:

  • ConnectorAPI: https://your-lifetime-example.com/your-custom-pipeline-connector-module/rest/ConnectorAPI

4. Create Pipeline Triggers using your custom Connector

4.1 Configure the plugin Default Server Settings

Select Configure Triggers from the plugin landing page in LifeTime and configure the following parameters:

  • Source Environment: <Select your OutSystems source environment.>
  • Pipeline Server Type: Other
  • Pipeline Server Address: <Your Pipeline Server instance address.>
  • Pipeline Server Credentials: <Credentials of an account with enough permissions for running pipeline jobs.>

image

4.2 Create a Pipeline Trigger

Pipeline triggers can be configured by providing the following data:

  • Pipeline: <Unique name that identifies the pipeline>
  • Trigger on Schedule: <Flag to trigger the pipeline based on a predefined schedule>
  • Source Environment: <Select your OutSystems source environment.>
  • Environment Labels (optional): <Define the label assigned to each OutSystems environment along the deployment path>
  • Applications: <List of LifeTime applications that will trigger the CI/CD pipeline, identifying which ones are Test applications>