Skip to main content

This component manages pipeline execution. By default the component skips duplicate merge request pipelines, any pipeline with an explicit skip marker, and merge request pipelines whose titles are documentation/maintenance-only conventional commit titles such as docs:, docs(scope):, chore:, and chore(scope):.

Usage

Example to skip branches

This will skip pipelines executed in the branch develop.

  • Create a new pipeline file
include:
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/workflow@stable
inputs:
name: project
pattern-branch-skip: '/^develop\$/'

Other examples of regex patterns to skip branches:

  • /^(?:main|dev)\$/ - skip all branches starting with main or dev

Default title skip patterns

By default, pattern-title-skip skips pipelines when the merge request title, tag message, or commit message contains an explicit skip marker such as [skip] or [skip ci].

pattern-merge-request-title-skip only applies to merge request pipelines and skips merge request titles matching these forms:

  • docs: ...
  • docs(scope): ...
  • chore: ...
  • chore(scope): ...

Inputs

NameDescriptionDefaultType
------------
pattern-branch-interruptibleRegex pattern to mark the pipeline as interruptible based on the branch name. Use https://github.com/google/re2/wiki/Syntax/^(feat\|fix\|hotfix)\//string
pattern-branch-skipRegex pattern to skip the pipeline based on the branch name. Use https://github.com/google/re2/wiki/Syntaxstring
pattern-merge-request-title-skipRegex pattern to skip merge request pipelines based on the merge request title./^(docs\|chore)(\([^)]*\))?:/string
pattern-title-skipRegex pattern to skip the pipeline based on the commit title/message./\[.*skip.*\]/string