GitLab API

GitlabTool

Actions1095

Projects → getApiV4ProjectsIdRepositoryChangelog

AI-generated

Summary

Retrieve the changelog of a specific GitLab project repository release version, optionally filtered by commit range, release date, trailer, and configuration file.

Inputs

  • id (required) — The ID or URL-encoded path of the project whose changelog to retrieve.
  • version (required) — The semantic version of the release for which to get the changelog.
  • from — The first commit SHA in the range of commits to include in the changelog.
  • to — The last commit SHA in the range of commits to include in the changelog.
  • date — The date and time of the release in ISO 8601 format.
  • trailer — The Git trailer key used to determine if commits should be included in the changelog, default is 'Changelog'.
  • config_file — The file path to the changelog configuration file in the repository, default is '.gitlab/changelog_config.yml'.
  • skipAuthentication — Optional flag to skip API authentication (default false).
  • baseUrl — The base URL of the GitLab instance, defaulting to 'https://gitlab.com'.

Output shape

a changelog object summarizing commits included in the specified release version of the project repository

The output corresponds to the response from the GitLab API endpoint '/api/v4/projects/{id}/repository/changelog'. The changelog is generated considering optional filters such as commit range (from/to), release date, Git trailer, and configuration file path.

Links

Discussion