Add a `description` entry to job definition in CI configuration
Release notes
Problem
A job name is usually a short string that rarely describes a purpose of the CI job adequately.
Intended users
Proposal
Add description keyword to a job definition in .gitlab-ci.yml.
NOTE: We will start with a 128 character limit for description and then adjust as we go in the future.
rspec:
script: rspec
description: 'Unit tests for GitLab'
rubocop:
script: rubocop
description: 'Static code analysis'If the description is present, show it the job detail page.
| Job detail page. |
|---|
 |
- The job detail page can show the full description.
Permissions and Security
Anyone who can create a CI YAML config will be able to add the description keyword to a job. Anyone who can see the pipeline graph will be able to see the tooltip description. Those users who can see the job detail page will see the description in the job page.
Documentation
The new keyword needs to be documented in the keyword reference as well as the jobs documentation.
Availability & Testing
Available Tier
- Free
Links / references
Edited by Sunjung Park