Generate changelog data

GET

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

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.

Authorizations

http
oauth2

Parameters

Path Parameters

required

One of:

string
integer

string

The ID or URL-encoded path of the project

Example

Query Parameters

version

required

string

nullable /(?:(?:(0|[1-9]\d*))\.(?:(0|[1-9]\d*))\.(?:(0|[1-9]\d*)))(?:(?:-((?:\d*[a-zA-Z\-][0-9a-zA-Z\-]*|[1-9]\d*|0)(?:\.(?:\d*[a-zA-Z\-][0-9a-zA-Z\-]*|[1-9]\d*|0))*))?(?:\+([0-9a-zA-Z\-]+(?:\.[0-9a-zA-Z\-]+)*))?)/

The version of the release, using the semantic versioning format

Example

1.0.0

from

string

nullable

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

Example

ed899a2f4b50b4370feeea94676502b42383c746

string

nullable

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

Example

6104942438c14ec7bd21c6cd5bd995272b3faff6

date

string format: date-time

nullable

The date and time of the release

Example

2021-09-20T11:50:22.001+00:00

trailer

string

default: Changelog nullable

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

Example

Changelog

config_file

string

nullable

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

Example

.gitlab/changelog_config.yml

config_file_ref

string

nullable

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

Example

main

Responses

200

application/json

object

notes

string

Example

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

400

Bad Request

404

Not Found