Deprecation warning component

Print a configurable warning when a component is deprecated and should no longer be used. The job exits with status 1 and is allowed to fail by default, so downstream projects see a visible warning without breaking existing pipelines.

Use it when a catalog component is renamed, replaced, or scheduled for removal.

Usage

include:
  - component: $CI_SERVER_FQDN/xrow-public/ci-tools/deprecation-warning@stable
    inputs:
      message: "This template is deprecated. Please use the optimized $CI_SERVER_FQDN/xrow-public/ci-tools/workflow template instead."

By default, the job runs on the default branch and prints the message with the [error]: 🚨 prefix:

[error]: 🚨 This template is deprecated. Please use the optimized gitlab.com/xrow-public/ci-tools/workflow template instead.

Override prefix, rules, or stage when a component needs a different rollout policy.

Inputs

Name	Description	Default	Type
---	---	---	---
allow-failure	Allow the deprecation warning job to fail without failing the pipeline.	true	boolean
message	The deprecation message to print.		string
name	The name of the deprecation warning job.	warning	string
needs	The jobs that this job depends on.	[]	array
prefix	The prefix prepended to the deprecation message.	[error]: 🚨	string
rules	Rules controlling when the deprecation warning job runs.	[{"if":"$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH","when":"always"}]	array
stage	The stage where the deprecation warning job runs.	.pre	string
tags	The runners that this job depends on.	[]	array

Usage​

Inputs​

Usage

Inputs