New "Expose :release yaml as steps via API" is missing CI_COMMIT_TAG_MESSAGE in example

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

Problem to solve

In the current example(s) of the new and awesome feature :release yaml as steps shows how to create a release from the pipeline. It even shows as an example how to use CI_COMMIT_TAG as the 'version'/name. The example even explains, how to 'first create the tag, using the UI or git cli and from the tag create a release'

One huge oversight here however, is that indeed, the 'git commit tag' indicates the 'release name/version' the tag can however also hold a message (like a commit does as well). Sadly the user is to 'write custom text' in the release text when creating a release from the pipeline. So most of the text would end up being static text, where we actually have a database, a storage method for the description already availalbe, int he form of the 'git commit tag message', which is created using git tag -a --message "my message subject" --message "My message body"

Obviously I do understand why the example doesn't show us HOW this is done, as the CI_COMMIT_TAG_MESSAGE obviously does not exist yet, due to issue #27615 needing to be resolved first.

Intended users

User experience goal

The user does not have to define a message in a .gitlab-ci.yaml file or run some magic there to generate the release description. Instead, creating the text as part of the release tag, stores the needed information and makes life easier for the, person doing the actual release tag.

Proposal

Resolve #27615 and update the documentation to show this variable being used in the example

Links / references

Edited by 🤖 GitLab Bot 🤖