{"id":49496,"date":"2025-05-27T03:32:36","date_gmt":"2025-05-27T03:32:36","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=49496"},"modified":"2025-06-09T04:04:08","modified_gmt":"2025-06-09T04:04:08","slug":"gitlab-ci-cd-pipeline-configuration-keywords","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/gitlab-ci-cd-pipeline-configuration-keywords\/","title":{"rendered":"GitLab CI\/CD Pipeline Configuration Keywords"},"content":{"rendered":"\n
\"Conhecendo<\/a><\/figure>\n\n\n\n

Below is a comprehensive table listing the key stanzas (keywords) used in GitLab CI\/CD pipeline configuration files (.gitlab-ci.yml<\/code>). These keywords are categorized based on their scope and functionality. This information is based on GitLab’s official documentation as of version 18.0.<\/p>\n\n\n\n

\n\n\n\n

\ud83d\udcd8 GitLab CI\/CD Pipeline Configuration Keywords<\/h3>\n\n\n\n
Keyword<\/strong><\/th>Scope<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
stages<\/a><\/code><\/td>Global<\/td>Defines the stages of the pipeline (e.g., build, test, deploy).<\/td><\/tr>
default<\/a><\/code><\/td>Global<\/td>Sets default values for jobs.<\/td><\/tr>
include<\/a><\/code><\/td>Global<\/td>Includes external YAML files into the pipeline configuration.<\/td><\/tr>
workflow<\/a><\/code><\/td>Global<\/td>Defines conditions to control pipeline creation.<\/td><\/tr>
variables<\/a><\/code><\/td>Global\/Job<\/td>Defines CI\/CD variables.<\/td><\/tr>
image<\/a><\/code><\/td>Global\/Job<\/td>Specifies the Docker image to use for jobs.<\/td><\/tr>
services<\/a><\/code><\/td>Global\/Job<\/td>Defines additional Docker services for jobs.<\/td><\/tr>
before_script<\/a><\/code><\/td>Global\/Job<\/td>Scripts to run before each job’s script<\/code>.<\/td><\/tr>
after_script<\/a><\/code><\/td>Global\/Job<\/td>Scripts to run after each job’s script<\/code>, regardless of success or failure.<\/td><\/tr>
cache<\/a><\/code><\/td>Global\/Job<\/td>Specifies files to cache between jobs.<\/td><\/tr>
pages<\/a><\/code><\/td>Job<\/td>Defines a job that uploads content to GitLab Pages.<\/td><\/tr>
script<\/a><\/code><\/td>Job<\/td>The shell commands to execute in the job.<\/td><\/tr>
stage<\/a><\/code><\/td>Job<\/td>Assigns the job to a stage.<\/td><\/tr>
only<\/code><\/td>Job<\/td>Specifies the conditions to include the job. (Deprecated in favor of rules<\/code>)<\/em><\/td><\/tr>
except<\/a><\/code><\/td>Job<\/td>Specifies the conditions to exclude the job. (Deprecated in favor of rules<\/code>)<\/em><\/td><\/tr>
rules<\/a><\/code><\/td>Job<\/td>Specifies conditions to include\/exclude jobs.<\/td><\/tr>
needs<\/a><\/code><\/td>Job<\/td>Defines job dependencies and allows out-of-order execution.<\/td><\/tr>
dependencies<\/a><\/code><\/td>Job<\/td>Specifies artifacts to pass between jobs.<\/td><\/tr>
artifacts<\/a><\/code><\/td>Job<\/td>Defines files to save after job completion.<\/td><\/tr>
retry<\/code><\/td>Job<\/td>Specifies the number of retries for a job on failure.<\/td><\/tr>
timeout<\/a><\/code><\/td>Job<\/td>Sets a timeout for the job.<\/td><\/tr>
when<\/code><\/td>Job<\/td>Specifies when to run the job (e.g., on_success, manual).<\/td><\/tr>
allow_failure<\/a><\/code><\/td>Job<\/td>Allows the job to fail without failing the pipeline.<\/td><\/tr>
parallel<\/a><\/code><\/td>Job<\/td>Defines parallel execution of a job.<\/td><\/tr>
trigger<\/a><\/code><\/td>Job<\/td>Triggers a downstream pipeline.<\/td><\/tr>
extends<\/a><\/code><\/td>Job<\/td>Inherits configuration from other jobs.<\/td><\/tr>
tags<\/a><\/code><\/td>Job<\/td>Specifies tags to select specific runners.<\/td><\/tr>
environment<\/a><\/code><\/td>Job<\/td>Defines the environment for deployment.<\/td><\/tr>
only:variables<\/code><\/td>Job<\/td>Specifies job inclusion based on variables. (Deprecated in favor of rules<\/code>)<\/em><\/td><\/tr>
except:variables<\/code><\/td>Job<\/td>Specifies job exclusion based on variables. (Deprecated in favor of rules<\/code>)<\/em><\/td><\/tr>
coverage<\/code><\/td>Job<\/td>Specifies how to extract code coverage info.<\/td><\/tr>
secrets<\/code><\/td>Job<\/td>Defines secrets to be used in jobs.<\/td><\/tr>
resource_group<\/code><\/td>Job<\/td>Limits job concurrency.<\/td><\/tr>
interruptible<\/code><\/td>Job<\/td>Allows jobs to be canceled when superseded by newer runs.<\/td><\/tr>
manual<\/code><\/td>Job<\/td>Marks job as manual, requiring user intervention. (Deprecated in favor of when: manual<\/code>)<\/em><\/td><\/tr>
start_in<\/code><\/td>Job<\/td>Delays the execution of a manual job.<\/td><\/tr>
inherit<\/code><\/td>Job<\/td>Controls inheritance of global configurations.<\/td><\/tr>
coverage:regex<\/code><\/td>Job<\/td>Specifies a regex to extract coverage info.<\/td><\/tr>
retry:when<\/a><\/code><\/td>Job<\/td>Specifies conditions under which to retry a job.<\/td><\/tr>
release<\/code><\/td>Job<\/td>Defines a release to be created after job completion.<\/td><\/tr>
id_tokens<\/code><\/td>Job<\/td>Defines OpenID Connect (OIDC) tokens for jobs.<\/td><\/tr>
workflow:rules<\/code><\/td>Global<\/td>Defines rules to control pipeline creation.<\/td><\/tr>
workflow:variables<\/code><\/td>Global<\/td>Defines variables at the workflow level.<\/td><\/tr>
workflow:inputs<\/code><\/td>Global<\/td>Defines inputs for the pipeline.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n

This table provides a comprehensive overview of the keywords used in GitLab CI\/CD pipeline configurations. For detailed information and examples on each keyword, you can refer to the official GitLab CI\/CD YAML syntax reference: (GitLab Documentation<\/a>).(GitLab Documentation<\/a>)<\/p>\n\n\n\n

<\/p>\n","protected":false},"excerpt":{"rendered":"

Below is a comprehensive table listing the key stanzas (keywords) used in GitLab CI\/CD pipeline configuration files (.gitlab-ci.yml). These keywords are categorized based on their scope and functionality. This information… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-49496","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49496","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=49496"}],"version-history":[{"count":4,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49496\/revisions"}],"predecessor-version":[{"id":49631,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/49496\/revisions\/49631"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=49496"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=49496"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=49496"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}