pr 定义
拉取请求触发器指定哪些分支导致拉取请求生成运行。
引用此定义的定义: 管道
实现形式
实现 | 描述 |
---|---|
pr:无 | 禁用拉取请求触发器。 |
pr: 字符串列表 | 触发运行的分支列表。 |
pr: autoCancel, 分支, 路径, 草稿 | 完整控制的完整语法。 |
实现 | 描述 |
---|---|
pr:无 | 禁用拉取请求触发器。 |
pr: 字符串列表 | 触发运行的分支列表。 |
pr: autoCancel, 分支, 路径 | 完整控制的完整语法。 |
备注
如果未指定拉取请求触发器,则向任何分支的拉取请求都会触发生成。
pr
关键字有三种不同的语法选项:要包括的分支列表、禁用拉取请求触发器的方法以及用于实现完全控制的完整语法。
重要
YAML 拉取请求触发器仅在 GitHub 和 Bitbucket Cloud 中受支持。 如果使用 Azure Repos Git,则可以配置用于生成验证的分支策略,以触发生成管道进行验证。
重要
YAML 拉取请求触发器仅在 GitHub 中受支持。 如果使用 Azure Repos Git,则可以配置用于生成验证的分支策略,以触发生成管道进行验证。
如果指定 exclude
子句而不包含 branches
或 paths
的 include
子句,则等同于在 include
子句中指定 *
。
重要
指定拉取请求触发器时,只有显式配置为包含的分支才会触发管道。 首先处理包含项,然后从该列表中移除排除项。 如果指定排除项但未指定包含项,则不会触发任何操作。
pr:无
禁用拉取请求触发器。
pr: none # Disable pull request triggers.
pr
字符串。 允许的值:无。
禁用拉取请求触发器。
示例
禁用语法:
pr: none # will disable PR builds (but not CI builds)
pr: 字符串列表
触发运行的分支列表。
pr: [ string ] # List of branches that trigger a run.
列表类型
类型 | 说明 |
---|---|
字符串 | 触发运行的分支列表。 |
备注
列表语法指定在引发拉取请求或推送到引发拉取请求的源分支时触发运行的分支列表。
示例
列出语法:
pr:
- main
- develop
pr: autoCancel, 分支, 路径, 草稿
如果需要完全控制拉取请求触发器,请使用完整语法。
pr:
autoCancel: boolean # Whether to cancel running PR builds when a new commit lands in the branch. Default: true.
branches: # Branch names to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
paths: # File paths to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
drafts: boolean # Whether to start a run when a draft PR is created. Default: true.
属性
autoCancel
布尔值。
当新提交落入分支时,是否取消正在运行的 PR 生成。 默认值:true。
branches
includeExcludeFilters。
要包含或排除以触发运行的分支名称。
paths
includeExcludeFilters。
要包含或排除以触发运行的文件路径。
drafts
布尔值。
是否在创建草稿 PR 时启动运行。 默认值:true。
pr: autoCancel, 分支, 路径
完整控制的完整语法。
pr:
autoCancel: boolean # Whether to cancel running PR builds when a new commit lands in the branch. Default: true.
branches: # Branch names to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
paths: # File paths to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
属性
autoCancel
布尔值。
当新提交落入分支时,是否取消正在运行的 PR 生成。 默认值:true。
branches
includeExcludeFilters。
要包含或排除以触发运行的分支名称。
paths
includeExcludeFilters。
要包含或排除以触发运行的文件路径。
pr:分支、路径
完整控制的完整语法。
pr:
branches: # Branch names to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
paths: # File paths to include or exclude for triggering a run.
include: [ string ] # List of items to include.
exclude: [ string ] # List of items to exclude.
属性
branches
includeExcludeFilters。
要包含或排除以触发运行的分支名称。
paths
includeExcludeFilters。
要包含或排除以触发运行的文件路径。
示例
完整语法:
pr:
branches:
include:
- features/*
exclude:
- features/experimental/*
paths:
exclude:
- README.md
请参阅
详细了解拉取请求触发器以及如何指定。