Skip to content

Add urls to generated changelogs

Niklas van Schrickrequested to merge
gitlab-community/gitlab-org/gitlab:add-urls-to-changelog into master
  • Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA

What does this MR do and why?

Tools like Renovate include changelogs in the MRs to update dependencies. The changelogs generated by GitLab only include a reference to the commit and MR. While the reference works for projects that are hosted on the same instance, it does not work, if you have dependencies from other instances (for example: you are self-hosted and use the helm chart for GitLab Runner, which is on gitlab.com)

There is no way to click the link to the MR or commit and you have to build the URL yourself if you want to look at the MR or commit.

Lets improve that by changing the reference to urls by default.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After
image image

How to set up and validate locally

  1. Visit flightjs/flight
  2. Make a commit with a changelog trailer and open a MR
  3. Merge the MR
  4. Call /api/v4/projects/7/repository/changelog?version=1.5.3 and verify the response
Edited by 🤖 GitLab Bot 🤖

Merge request reports