Feedback issue for the new changelog generation API
In #1525 (closed) and #1539 (closed) we discuss testing the new changelog generation API using GitLab Pages and Gitaly.
In this issue we want to collect feedback from the GitLab community as a whole about this feature. This helps us better understand how useful the new API is to our users.
More details about this feature can be found in epics &351 (closed) and &399 (closed), but we will summarise them here to make things easier:
GitLab is introducing an API that lets you generate changelog data, using commit subjects as the input for the changelog. Using a range of commits and a new version to release, GitLab fetches a specific set of commits and turns these into a Markdown changelog. The output can be customised using a template, and commits are categorised using a Git trailer.
For more information, refer to the documentation of this feature.
Example API usage
To use the API, you would perform a call (e.g. using curl) like so:
curl --header 'PRIVATE-TOKEN: hunter2' \
-d "version=1.5.0&from=FOO&to=BAR&branch=master" \
https://gitlab.com/api/v4/projects/PROJECT_ID/repository/changelog
Here FOO
and BAR
signal the start and end of the commit range to use for
generating the changelog. PROJECT_ID
would be the ID of your GitLab project.
Requirements
To best use this feature, make sure that:
- You create a Git tag for every version, using the format
vX.Y.X
, whereX.Y.Z
is a version that uses semantic versioning. - Your versions (the one you specify in the
version
argument) also follow semantic versioning.
Giving feedback
To make digesting feedback easier, please start a new thread for every
suggestion/issue/etc. If somebody already has given the feedback you were
planning on giving, please upvote their comment using the
Please note that at this time we are not planning on adding support for different output methods (e.g. a GNU changelog file), or different input methods (e.g. merge request titles). The reasoning for this can be found in the epics mentioned earlier.