Managing pipelines
Go can be configured using Administration Tab. You can perform operations like add/edit Pipelines, Stages, Jobs, Tasks, Templates and Pipeline group. You can also configure Go by editing the full XML file if you wish, by clicking on the Source XML section of the Administration tab. Go will check the syntax of the configuration before it saves it again
Creating a new pipeline
To create a new pipeline, go to the Pipelines sub-tab of the Administration tab and click on the "Create a new pipeline within this group" link as shown in the screen shot below.
Add a new stage to an existing pipeline
Now that you have a pipeline with a single stage, lets add more stages to it.
- Navigate to the new pipeline you created by clicking on the Edit link under the Actions against it. You can also click on the name of the pipeline.
- Click on the Stages tab.
- You will notice that a defaultStage exists. Click on the "Add new stage" link.
- Fill stage name and trigger type.
- Fill in the details for the first job and first task belonging to this job. You can add more jobs and add more tasks to the jobs.
- Click "Save".
- Click on help icon next to the fields to get additional details about the fields you are editing.
Add a new job to an existing stage
Now that we have a pipeline with stage(s), we can add more jobs to any of the existing stages. You can now use the tree navigation on the left side of the screen to edit a stage or a job under a pipeline.
- Click on the stage name that you want to edit on the tree as shown below. The "defaultStage" is being edited.
- Click on the Jobs tab
- Click on "Add new job"
- Fill job name and job details
- Fill in the details for the initial task belonging to this job. You can edit this job later to add more tasks
- You can choose the type of the task as required.
- For task types Ant, Nant and Rake, the build file and target will default as per the tool used. For example, Ant task, would look for build.xml in the working directory, and use the default task if nothing is mentioned.
- Click on help icon next to the fields to get additional details about the fields you are editing.
- Click "Save"
Add a new task to an existing Job
Now that we have a pipeline with stage(s) containing job(s) we can add tasks to any of the existing jobs. You can now use the tree navigation on the left side of the screen to edit a a job under a stage.
- Click on the job name that you want to edit on the tree as shown below. The "defaultJob" is being edited.
- Click on "Add new task". You can choose the task type from Custom Command, Ant, Nant, Rake and Fetch Artifact.
- Fill the basic settings for the task
- Click on help icon next to the fields to get additional details about the fields you are editing.
- Click "Save"
- Advanced Options section allows you to specify another Task (Custom Command, Ant, Nant or Rake) which can be used to specify the actions (typically clean up) that needs to be taken when users chooses to cancel the stage.
Clone an existing pipeline
Clone pipeline functionality helps you create a new pipeline from an existing pipeline by giving it a new name. Typically when setting up a pipeline for a new branch, it is very useful to take an existing pipeline and clone it.
If the user is a pipeline group admin, she can clone the new pipeline into a group that she has access to. If the user is an admin she can clone the pipeline into any group or give a new group name, in which case the group gets created.
- Navigate to the Admin tab
- Locate the pipeline that needs to be cloned
- In that row, click on the "Clone" icon.
- Fill in the name of the new pipeline
- Select a pipeline group. If you are an admin, you will be able to enter the name of the pipeline group using the auto suggest or enter a new group name
- Click "Save"
Stage approvals in action
By default, when one stage completes successfully, the next stage is automatically triggered by Go. However sometimes you don't want the next stage to be triggered automatically. This might be the case if you have a stage that deploys your application to a testing, staging or production environment. Another case can be when you don't want your pipeline to be automatically triggered by changes in version control. In these situations, you want the stage triggered by manual intervention. This can be done through manual approvals.
If you add a manual approval to the first stage in a pipeline, it will prevent the pipeline from being triggered from version control. Instead, it will only pick up changes when you trigger the pipeline manually (this is sometimes known as "forcing the build").
From Cruise 1.1 (legacy version of Go), you can control who can trigger manual approvals. See the section on Adding authorization to approvals for more details.
Managing pipeline groups
Starting with Cruise 1.3 (legacy version of Go), the professional edition includes support for collecting multiple pipelines into a single named group. See the section on Specifying who can view and operate pipeline groups for more details.
