GIgitlab
repositories

Generate changelog data

Generates changelog data based on commits in a repository, without committing them to a changelog file. Works exactly like POST /projects/:id/repository/changelog, except the changelog data is not committed to any changelog file.

get/api/v4/projects/{id}/repository/changelog

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

Query parameters

versionstring required

The version of the release, using the semantic versioning format

fromstring

The first commit in the range of commits to use for the changelog

tostring

The last commit in the range of commits to use for the changelog

datestring date-time

The date and time of the release

trailerstring

The Git trailer to use for determining if commits are to be included in the changelog

config_filestring

The file path to the configuration file as stored in the project's Git repository. Defaults to '.gitlab/changelog_config.yml'

config_file_refstring

The git reference (for example, branch) where the changelog configuration file is defined. Defaults to the default repository branch.

Response

Generate changelog data

notesstring required

Example response

{
  "notes": "## 1.0.0 (2023-01-01)"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.