Skip to content

Clarify behavior of various triggered pipelines

Marcel Amirault requested to merge docs-pipeline-trigger-clarification into master

What does this MR do?

From the linked issues, lots of people are struggling with defining rules for rules and only/except, as the values vary depending on the pipeline type, and there are multiple types of "triggered" pipelines:

  • api
  • pipelines / pipeline
  • triggers

This adds lots of clarifications and crosslinks to try to make it clearer which keywords should be used in each situation, and removes some ancient notes spread throughout the triggers docs that made it hard to read.

  • Crosslinks in the rules table for pipeline and trigger
  • Crosslinks in the only/except table for pipelines and trigger
  • Notes in the Multi-project pipelines doc explaining that it's of pipeline/pipelines type for both bridge jobs pipelines and CI_JOB_TOKEN pipelines.
  • The triggers doc already had clarification details added in !28442 (merged), so just a light cleanup of the notes.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports

Loading