includeExcludeFilters definition

Lists of items to include or exclude for trigger events.

includeExcludeFilters:
  include: [ string ] # List of items to include.
  exclude: [ string ] # List of items to exclude.

Note

This definition is a supporting definition and is not intended for use directly in a pipeline. This article provides the YAML syntax for this supporting type, but does not show usage examples. For more information and examples for using this supporting type, see the following Definitions that reference this definition articles.

Definitions that reference this definition: trigger, pr, schedules.cron

Properties

include string list.
List of items to include.

include:
- item1
- item2

You can also specify the include list on a single line using the following format.

include: [ item1, item2 ]

For example, to specify a list of branches to match in a pr trigger, use the following syntax.

pr:
  branches:
    include:
    - main
    - features/*

You can also specify the includes list on a single line using the following format.

pr:
  branches:
    include: [ main, features/* ]

exclude string list.
List of items to exclude.

exclude:
- item1
- item2

You can also specify the exclude list on a single line using the following format.

exclude: [ item1, item2 ]

Remarks

The includeExcludeFilters definition is a supporting definition and is not intended for use directly in a pipeline; instead it is used to provide the structure of different properties in the definitions listed at the top of the article.

For example, includeExcludeFilters is the type that defines how the pr.branches section is structured. See the pr implementations Full syntax for complete control section for the pr properties that use includeExcludeFilters.

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.