Skip to content

Deprecate and remove workflow:rules templates

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

We should deprecate the workflow:rules templates. Using these templates makes it harder to make use of all the latest workflow features and subkeys, as it hides some of the workflow configuration in the template.

These templates were originally added a long time ago when rules was a new feature and people were struggling to use them. Now that rules has been the standard for years, and we have good options documented that users can use to start with, we should pull out the old templates and drive people towards actually using the workflow keyword.

Breaking Change

This is a breaking change. Users can simply add workflow: rules to their pipeline configuration explictly: https://docs.gitlab.com/ee/ci/yaml/workflow.html#common-if-clauses-for-workflowrules

Affected Topology

All CI/CD pipeline users, though the use of these templates seem to be a small minority. Metrics used to be located at: https://app.periscopedata.com/app/gitlab/785953/Pipeline-Authoring-Dashboard?widget=13440051&udv=0, though we might need a new query to verify the impact.

Affected Tier

  • Free
  • Premium
  • Ultimate

Checklists

Labels

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

Timeline

Please add links to the relevant merge requests.

  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 14.8, 14.9, 14.10, 15.0 – 14.8 is the third milestone preceding the major release):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

Mentions

  • Your stage's stable counterparts have been @mentioned on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.
    • To see who the stable counterparts are for a product team visit product categories
      • If there is no stable counterpart listed for Sales/CS please mention @timtams
      • If there is no stable counterpart listed for Support please mention @gitlab-com/support/managers
      • If there is no stable counterpart listed for Marketing please mention @cfoster3
  • Your GPM has been @mentioned so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.

Deprecation Milestone

Planned Removal Milestone

Links

Edited by 🤖 GitLab Bot 🤖