Ability to interact with changelog API
Problem to solve
As a GitLab user who maintains a checked-in changelog, I want the ability to interact with the GitLab changelog endpoint under the repositories API via the glab
CLI tool. Currently, users are able to interact with the endpoint either by issuing a CURL command or writing their own script to do so. This works, but it would be useful to be able to interact with the endpoint via the official glab
CLI tool. In particular, I would like the ability to generate changelog data and have the output rendered in a human friendly way.
If there is already a recommended way to do this, I'd love to hear it. This is just a request since I currently don't have a better workflow, and I believe it is within the purview of the tool.
I like this tool and am happy to contribute to this feature if it would be helpful.
Proposal
It may make sense to create a new top-level subcommand for interacting with the changelog endpoint (i.e. glab changelog <options>
) so that the command can be extended to support more of the changelog endpoint than just generating changelog data.
When generating changelog data from commits, I think the version
attribute in the GET request could be inferred by using the output of git describe
.
The project :id
can also be inferred, I think. The rest of the attributes could be supplied via optional flags (if at all initially).
Further details
Potential use case could be:
- Partially automating the production of a changelog.
- Viewing changelog info directly in the terminal (perhaps duplicates functionality of
glab release
though).
Links / references
Changelog endpoint: https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data