Pipelines are used to standardize and automate the build and deployment of apps. Platform Administrators can create global, group or app pipelines, enabling you to enforce standards across all of your apps. However, it is also possible to allow Group Administrators and App Administrators to create pipelines if you want to allow more freedom and flexibility in creating releases. For more informtion on enabling this feature see the System Configuration documentation.
There are 3 different types of pipelines:
Global. These pipelines apply (and are visible) to all apps. Only Platform Administrators can manage global pipelines.
Group. These pipelines apply (and are visible) to all apps in a specific group. Only Platform and Group Administrators can manage group pipelines.
App. These pipelines apply (and are visible) to a single app only. Platform, Group and App Administrators can manage app pipelines.
By default only Platform Administrators can create pipelines. Pipelines created by Platform Administrators are read-only for other administrators.
If you want Group or App Administrators to be able to create their own pipleines you must enable this feature in the System Configuration page.
After a pipeline has been created they are automatically available to be used for a release by an app administrator and do not require additional configuration.
To add a new pipeline click on 'add pipeline'.
Info
When adding a new pipeline the following options are available:
Name: This is the name that is visible to users of the pipeline. Note: When changing the name it is immediately saved. You don't need to click the 'save' button to make this visible.
Version: The version of this pipeline. The version is incremented automatically when you choose to update the pipeline. When new releases are created that use this pipeline, the newest version will always be used.
By default a pipeline is enabled. If you want to disable a pipeline click on the 'disable pipeline' button. When a pipeline is disabled is cannot be executed and it is no longer visible as an option when creating a new release.
Scheduling
Chose the scheduling configuration that you want to use for this pipeline. The following scheduling options are available
On Demand: This pipeline will be available to users when manually creating a release.
On Commit: A new release will be automatically creates when a new commit is detected for the selected branch.
Daily: A new release will be created daily for the selected branch.
Weekly: A new release will be created daily for the selected branch.
Note: For On Commit, Daily or Weekly schedules, the pipeline will only be scheduled for an app after an App Administrator creates a new release for their app. After that, the release will automatically be created and updated.
Versioning
Configure how version numbers and release notes are generated for each release created by this pipeline. Note: These options are used when creating a new release either manually (On Demand) or automatic (a pipeline that uses a recurring schedule). When creating a release manually it is possible to override the version number and release notes.
Base Release Number: This is the base release number that will be used for generating release numbers for releases. For each new release the base release number will be incremented.
Release number generation: How the base release number will be incremented. The following options are available:
Increment patch version (BRANCH): The patch version number of the last successful release for the selected branch will be incremented by 1.
Increment minor version (BRANCH): The minor version number of the last successful release for the selected branch will be incremented by 1.
Increment patch version (APP): The patch version number of the last successful release for the app will be incremented by 1.
Increment minor version (APP): The minor version number of the last successful release for the app will be incremented by 1.
Release notes generation: How release notes will be generated for a release. The following options are available:
Use latest commit: The commit message of the revision used for the release will be used.
Use last release: The commit messages of all revisions since the last successful release for the selected branch will be used. Note: This total length of the release notes will be truncated to 2000 characters.
Actions
At the bottom of the pipeline page the following actions are available:
Update pipeline: This action will apply the changes you made on the page, and will increment the version number of the pipeline.
Enable: If a pipeline is disabled you can renable it. This makes the pipeline visible to app administrators to be used for new releases.
Disable: By default a pipeline is enabled. If you want to disable a pipeline click on this button/ When a pipeline is disabled is cannot be executed and it is no longer visible as an option when creating a new release.
Delete: If you delete a pipeline it cannot be used for releases anymore. All pipeline configurations will be deleted, however historical release information will not be affected.
By default a pipeline is enabled. If you want to disable a pipeline click on the 'disable pipeline' button. When a pipeline is disabled is cannot be executed and it is no longer visible as an option when creating a new release.
Pipeline Tasks
A pipeline consists of 1 or more tasks that are executed in order. A variety of task types are available to choose from. Click on 'add task' to add a new task to your pipeline. After selecting a task type a pop-up will appear enabling you to configure the task.
See the sub-pages of this page for information about each task type.
