Pipeline sources (sources) are used to declare the code sources and artifacts that trigger the pipeline, defining "where the pipeline comes from and why it starts". Through the sources block, you can connect to multiple code repositories such as GitHub, GitLab, and more, configure branch filtering, path filtering, and event trigger rules, and support configuring multiple code sources simultaneously.

tip

In Pipeline as Code, code sources only support access through service connection. For methods to create a service connection, see Service connection.

## YAML example ```YAML sources: - name: svcConn-demo type: Gitee url: https://gitee.com/volc-code-pipeline/demo.git branch: master credential: type: serviceConnection serviceConnectionId: ctAIccWNZvRLkgffPWXF trigger: triggerExecutionType: AllEvents autoPRComment: commentRule: PipelineStatus triggerEvents: - eventType: Push branchFilters: - master - dev ``` ## Basic configuration parameters |**Parameter** |Required |**Description** | |---|---|---| |sources.name |Yes |Code source name. During pipeline runtime, source files will be downloaded to the `/workspace` directory. The name must meet the following requirements:

* Can only include lowercase letters (a\-z), digits (0\-9), and hyphens (\-).

* Must start with a lowercase letter or digit.

* Must end with a lowercase letter or digit.

* Length must be 1~40 characters. | |sources.type |Yes |Code source type. For supported code source types, see [Code source overview](https://www.volcengine.com/docs/6461/1158271). | |sources.url |Yes |Code source repository URL, supports HTTPS protocol. | |sources.branch |Yes |Pipeline running branch. | |sources.branchMode |No |Branch mode is not enabled by default. Only one code source is allowed to enable branch mode. | |sources.branchMode.baseBranch |Required when branch mode is enabled. |Required when branch mode is enabled. The base branch for pulling code in branch mode. | |sources.cloneDepth

|No |Default is 1. Clone depth value represents the number of recent versions to clone.

* 0 means clone all versions.

* 1 means clone only the most recent version. | ## Authorization configuration |**Parameter** |Required |**Description** | |---|---|---| |sources.credential |Yes |Authorization information for cloning the code source. | |sources.credential.type |Yes |Enter `serviceConnection` as a fixed value, indicating the use of a service connection. | |sources.credential.serviceConnectionId |Yes |ID. Go to **Global settings \> Service connection** to view the target service connection's ID in the service list. | ## Trigger configuration |**Parameter** |Required |**Description** | |---|---|---| |sources.trigger |No |If not configured, the pipeline cannot be triggered by code source events. | |sources.trigger.triggerEvents.eventType |Yes |

tip

The trigger events supported by different code sources may vary. For details, see code source trigger.

Trigger event types, with the following values:

* `Push`: Code push event, commonly used for continuous integration with the main and feature branches.

* `CreateTag`: Tag creation event, commonly used for version release.

* `PRMerged`: Event after a merge request is merged.

* `PRUpdated`: Event when a merge request is created or updated, commonly used for pre\-merge validation. | |sources.trigger.triggerEvents.branchFilters |No |Branch filter list, supports entering branch names or Go language regular expressions. | |sources.trigger.triggerExecutionType |No |Type of trigger event execution. The values are as follows:

* `OnlyLatest`: Only the latest event triggers execution.

* `AllEvents`: All events trigger execution. | |sources.trigger.triggerExecutionType.autoPRComment.commentRule |No |After pipeline execution is complete, automatically post a comment in the pull request (PR). Only takes effect when `eventType` is `PRUpdated`. Valid values:

* PipelineTaskStatus: The comment includes the pipeline running state and each task running state.

* PipelineStatus: The comment only includes the pipeline running state.

* None: No automatic comment. |

Code Pipeline