Skip to content

Add CI_PROJECT_DESCRIPTION to predefined variables

Nejc Habjan requested to merge nejc/gitlab:feat/ci-project-description into master

What does this MR do and why?

Closes CI environment variable for project description (#339065 - closed)

This exposes project.description in a CI_PROJECT_DESCRIPTION predefined variable in CI jobs, similar to CI_PROJECT_TITLE added a few years ago.
Some static site generators can use this to generate config when using GitLab Pages without duplicating the project configuration.
For example, MkDocs uses site_description to add a meta tag to the generated HTML header. https://www.mkdocs.org/user-guide/configuration/#site_description

Screenshots or screen recordings

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Nejc Habjan

Merge request reports