Loading
Render deployment release notes GFM when the release loads
What does this MR do and why?
On the deployment detail page the release notes' GFM was not rendered — renderGFM ran at mount, before the async release query resolved. This watches the release description and runs renderGFM once it is present, so references, syntax highlighting, and other GFM behaviors apply to the notes.
References
Screenshots or screen recordings
| Before | After |
|---|---|
![]() |
![]() |
How to set up and validate locally
The release-notes block only shows on a deployment whose ref is a git tag that has a matching Release, and this change is only visible when that Release's description contains GFM. To create that state:
- Add a
.gitlab-ci.ymlthat deploys tags to an environment:deploy: stage: deploy script: echo "Deploying $CI_COMMIT_TAG" environment: name: production rules: - if: $CI_COMMIT_TAG - Go to Deploy → Releases → New release, create a new tag (e.g.
v1.0.0), and give the release a description with GFM — an issue reference#1and a fenced code block. Creating the release makes the tag, which triggers a tag pipeline; thedeployjob records a deployment toproduction. - Open the deployment via Operate → Environments → production → the
v1.0.0deployment (/<project>/-/environments/:environment_id/deployments/:iid). - In the release notes block under the header, confirm the GFM is processed —
#1renders as an issuable link (hover shows the popover) and the code block is syntax-highlighted. Before this change the notes render as plain, unprocessed HTML. - Run the spec:
yarn jest spec/frontend/deployments/components/deployment_header_spec.js VUE_VERSION=3 yarn jest spec/frontend/deployments/components/deployment_header_spec.js
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Edited by Anna Vovchenko

