GIgitlab
repositories

Add changelog data to file

Adds changelog data to file.

post/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

Request body

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.

branchstring

The branch to commit the changelog changes to

filestring

The file to commit the changelog changes to

messagestring

The commit message to use when committing the changelog

Example request

{
  "version": "1.0.0",
  "from": "ed899a2f4b50b4370feeea94676502b42383c746",
  "to": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
  "date": "2021-09-20T11:50:22.001+00:00",
  "trailer": "Changelog",
  "config_file": ".gitlab/changelog_config.yml",
  "config_file_ref": "main",
  "branch": "main",
  "file": "CHANGELOG.md",
  "message": "Initial commit"
}

Response

Add changelog data to file

Changes

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