Add changelog data to file

POST

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

• GitLab REST API

Adds changelog data to file.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Example

1

Request Body

Media typeapplication/json

object

from

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

string

nullable

Example

ed899a2f4b50b4370feeea94676502b42383c746

to

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

string

nullable

Example

6104942438c14ec7bd21c6cd5bd995272b3faff6

date

The date and time of the release

string format: date-time

nullable

Example

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

trailer

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

string

default: Changelog nullable

Example

Changelog

config_file

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

string

nullable

Example

.gitlab/changelog_config.yml

config_file_ref

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

string

nullable

Example

main

branch

The branch to commit the changelog changes to

string

nullable

Example

main

file

The file to commit the changelog changes to

string

default: CHANGELOG.md nullable

Example

CHANGELOG.md

message

The commit message to use when committing the changelog

string

nullable

Example

Initial commit

Responses

200

OK

400

Bad Request

404

Not Found