GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → getApiV4ProjectsIdRepositoryChangelog

AI-generated

Summary

Fetch the changelog for a specific project's repository release via GitLab's API v4, using required parameters such as project ID and release version, with optional filters like commit range, release date, and changelog configuration.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project whose changelog is to be retrieved.
  • version (required) — The semantic version string of the release for which the changelog is generated.
  • from — The commit hash indicating the start of the commit range included in the changelog.
  • to — The commit hash indicating the end of the commit range included in the changelog.
  • date — The release date and time, formatted as an ISO 8601 date-time string.
  • trailer — The Git trailer label used to filter commits for inclusion in the changelog, defaulting to 'Changelog'.
  • config_file — Relative file path in the repository to a changelog configuration file, defaulting to '.gitlab/changelog_config.yml'.

Output shape

a JSON object representing the changelog generated by GitLab for the specified project release

The output corresponds directly to GitLab's API response for the changelog endpoint at /api/v4/projects/{id}/repository/changelog. Responses may vary based on provided query parameters. Authentication via the configured GitLab API credential is required unless explicitly skipped.

Examples

Example 1: Getting changelog for project '123' release version '1.0.0'

Set 'id' to '123' and 'version' to '1.0.0'; optionally provide commit hashes 'from' and 'to' for commit range filtering.

Links

Discussion