How does CHANGELOG.md files are generated

Hi, is there any documentation about how does CHANGELOG.md file is generated for GitLab releases?

I know there is bin/changelog script inside the gitlab-ce repository, but as far I understand it only creates a new yaml record inside changelogs/unreleased directory. How are they converted into nice Markup and copied to CHANGELOG.md?

I see there is a bot for it (https://gitlab.com/gitlab-release-tools-bot) with an automatic task (https://gitlab.com/gitlab-org/gitlab-ce/commit/b0dc4425dd1a4abac07413ed8290b7dc651914d1) but I can’t find any source for it.

I would be grateful if you will let me know how to do it on my own.

Best regards,
Marcin

Hi Marcin,

I think the release-tools project is what you are looking for.

And in particular: https://gitlab.com/gitlab-org/release-tools/tree/master/lib/changelog

Here is also some more background info on GitLab changelog entries:

https://docs.gitlab.com/ee/development/changelog.html

I hope this helps!

Hi @dplanella, thanks for the message. That’s what I was looking for. Maybe not exactly (I was hoping that there is a simple one file script like changelog) but it should be enough.

Thank you!

1 Like