debian-mirror-gitlab/doc/api/commits.md

884 lines
30 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Create
group: Source Code
2022-03-02 08:16:31 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-03-11 19:13:27 +05:30
# Commits API **(FREE)**
2021-09-04 01:27:46 +05:30
This API operates on [repository commits](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository). Read more about [GitLab-specific information](../user/project/repository/index.md#commit-changes-to-a-repository) for commits.
2014-09-02 18:07:02 +05:30
2022-04-04 11:22:00 +05:30
## Responses
In commit responses, `created_at` and `committed_date` are identical.
However, `committed_date` and `authored_date` are generated from different sources,
and may not be identical.
2014-09-02 18:07:02 +05:30
## List repository commits
Get a list of repository commits in a project.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/repository/commits
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2019-12-21 20:55:43 +05:30
| `ref_name` | string | no | The name of a repository branch, tag or revision range, or if not given the default branch |
2021-04-17 20:07:23 +05:30
| `since` | string | no | Only commits after or on this date are returned in ISO 8601 format `YYYY-MM-DDTHH:MM:SSZ` |
| `until` | string | no | Only commits before or on this date are returned in ISO 8601 format `YYYY-MM-DDTHH:MM:SSZ` |
2018-03-27 19:54:05 +05:30
| `path` | string | no | The file path |
| `all` | boolean | no | Retrieve every commit from the repository |
2021-04-17 20:07:23 +05:30
| `with_stats` | boolean | no | Stats about each commit are added to the response |
2019-12-21 20:55:43 +05:30
| `first_parent` | boolean | no | Follow only the first parent commit upon seeing a merge commit |
2020-03-13 15:44:24 +05:30
| `order` | string | no | List commits in order. Possible values: `default`, [`topo`](https://git-scm.com/docs/git-log#Documentation/git-log.txt---topo-order). Defaults to `default`, the commits are shown in reverse chronological order. |
2021-09-04 01:27:46 +05:30
| `trailers` | boolean | no | Parse and include [Git trailers](https://git-scm.com/docs/git-interpret-trailers) for every commit |
2018-03-27 19:54:05 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits"
2016-04-02 18:10:28 +05:30
```
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2014-09-02 18:07:02 +05:30
```json
[
{
"id": "ed899a2f4b50b4370feeea94676502b42383c746",
"short_id": "ed899a2f4b5",
"title": "Replace sanitize with escape once",
2020-04-08 14:13:33 +05:30
"author_name": "Example User",
"author_email": "user@example.com",
2022-06-21 17:19:12 +05:30
"authored_date": "2021-09-20T11:50:22.001+00:00",
2017-08-17 22:00:37 +05:30
"committer_name": "Administrator",
"committer_email": "admin@example.com",
2022-06-21 17:19:12 +05:30
"committed_date": "2021-09-20T11:50:22.001+00:00",
"created_at": "2021-09-20T11:50:22.001+00:00",
2015-11-26 14:37:03 +05:30
"message": "Replace sanitize with escape once",
2017-08-17 22:00:37 +05:30
"parent_ids": [
"6104942438c14ec7bd21c6cd5bd995272b3faff6"
2020-04-08 14:13:33 +05:30
],
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
2014-09-02 18:07:02 +05:30
},
{
"id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
"short_id": "6104942438c",
"title": "Sanitize for network graph",
"author_name": "randx",
2020-04-08 14:13:33 +05:30
"author_email": "user@example.com",
"committer_name": "ExampleName",
"committer_email": "user@example.com",
2022-06-21 17:19:12 +05:30
"created_at": "2021-09-20T09:06:12.201+00:00",
2015-11-26 14:37:03 +05:30
"message": "Sanitize for network graph",
2017-08-17 22:00:37 +05:30
"parent_ids": [
"ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
2020-04-08 14:13:33 +05:30
],
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
2014-09-02 18:07:02 +05:30
}
]
```
2016-11-03 12:29:30 +05:30
## Create a commit with multiple files and actions
Create a commit by posting a JSON payload
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
POST /projects/:id/repository/commits
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
2019-10-12 21:52:04 +05:30
| `branch` | string | yes | Name of the branch to commit into. To create a new branch, also provide either `start_branch` or `start_sha`, and optionally `start_project`. |
2016-11-03 12:29:30 +05:30
| `commit_message` | string | yes | Commit message |
2019-10-12 21:52:04 +05:30
| `start_branch` | string | no | Name of the branch to start the new branch from |
| `start_sha` | string | no | SHA of the commit to start the new branch from |
2021-09-30 23:02:18 +05:30
| `start_project` | integer/string | no | The project ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) to start the new branch from. Defaults to the value of `id`. |
2016-11-03 12:29:30 +05:30
| `actions[]` | array | yes | An array of action hashes to commit as a batch. See the next table for what attributes it can take. |
| `author_email` | string | no | Specify the commit author's email address |
| `author_name` | string | no | Specify the commit author's name |
2018-12-05 23:21:45 +05:30
| `stats` | boolean | no | Include commit stats. Default is true |
2019-10-12 21:52:04 +05:30
| `force` | boolean | no | When `true` overwrites the target branch with a new commit based on the `start_branch` or `start_sha` |
2016-11-03 12:29:30 +05:30
| `actions[]` Attribute | Type | Required | Description |
| --------------------- | ---- | -------- | ----------- |
2018-12-05 23:21:45 +05:30
| `action` | string | yes | The action to perform, `create`, `delete`, `move`, `update`, `chmod`|
2016-11-03 12:29:30 +05:30
| `file_path` | string | yes | Full path to the file. Ex. `lib/class.rb` |
2018-12-05 23:21:45 +05:30
| `previous_path` | string | no | Original full path to the file being moved. Ex. `lib/class1.rb`. Only considered for `move` action. |
2021-04-17 20:07:23 +05:30
| `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` preserve the existing file content, and any other value of `content` overwrites the file content. |
2016-11-03 12:29:30 +05:30
| `encoding` | string | no | `text` or `base64`. `text` is default. |
2021-04-17 20:07:23 +05:30
| `last_commit_id` | string | no | Last known file commit ID. Only considered in update, move, and delete actions. |
2018-12-05 23:21:45 +05:30
| `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2016-11-03 12:29:30 +05:30
PAYLOAD=$(cat << 'JSON'
{
2017-08-17 22:00:37 +05:30
"branch": "master",
2016-11-03 12:29:30 +05:30
"commit_message": "some commit message",
"actions": [
{
"action": "create",
"file_path": "foo/bar",
"content": "some content"
},
{
"action": "delete",
2017-09-10 17:25:29 +05:30
"file_path": "foo/bar2"
2016-11-03 12:29:30 +05:30
},
{
"action": "move",
"file_path": "foo/bar3",
"previous_path": "foo/bar4",
"content": "some content"
},
{
"action": "update",
"file_path": "foo/bar5",
"content": "new content"
2018-12-05 23:21:45 +05:30
},
{
"action": "chmod",
"file_path": "foo/bar5",
"execute_filemode": true
2016-11-03 12:29:30 +05:30
}
]
}
JSON
)
2021-09-04 01:27:46 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
--data "$PAYLOAD" "https://gitlab.example.com/api/v4/projects/1/repository/commits"
2016-11-03 12:29:30 +05:30
```
Example response:
2019-07-31 22:56:46 +05:30
2016-11-03 12:29:30 +05:30
```json
{
"id": "ed899a2f4b50b4370feeea94676502b42383c746",
"short_id": "ed899a2f4b5",
"title": "some commit message",
2020-04-08 14:13:33 +05:30
"author_name": "Example User",
"author_email": "user@example.com",
"committer_name": "Example User",
"committer_email": "user@example.com",
2016-11-03 12:29:30 +05:30
"created_at": "2016-09-20T09:26:24.000-07:00",
"message": "some commit message",
"parent_ids": [
"ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
],
"committed_date": "2016-09-20T09:26:24.000-07:00",
"authored_date": "2016-09-20T09:26:24.000-07:00",
"stats": {
"additions": 2,
"deletions": 2,
"total": 4
},
2020-04-08 14:13:33 +05:30
"status": null,
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
2016-11-03 12:29:30 +05:30
}
```
2021-09-30 23:02:18 +05:30
GitLab supports [form encoding](index.md#encoding-api-parameters-of-array-and-hash-types). The following is an example using Commit API with form encoding:
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
curl --request POST \
--form "branch=master" \
--form "commit_message=some commit message" \
--form "start_branch=master" \
2019-07-31 22:56:46 +05:30
--form "actions[][action]=create" \
--form "actions[][file_path]=foo/bar" \
--form "actions[][content]=</path/to/local.file" \
--form "actions[][action]=delete" \
--form "actions[][file_path]=foo/bar2" \
--form "actions[][action]=move" \
--form "actions[][file_path]=foo/bar3" \
--form "actions[][previous_path]=foo/bar4" \
--form "actions[][content]=</path/to/local1.file" \
--form "actions[][action]=update" \
2019-07-07 11:18:12 +05:30
--form "actions[][file_path]=foo/bar5" \
2019-07-31 22:56:46 +05:30
--form "actions[][content]=</path/to/local2.file" \
--form "actions[][action]=chmod" \
2019-07-07 11:18:12 +05:30
--form "actions[][file_path]=foo/bar5" \
2019-07-31 22:56:46 +05:30
--form "actions[][execute_filemode]=true" \
2019-07-07 11:18:12 +05:30
--header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/projects/1/repository/commits"
```
2014-09-02 18:07:02 +05:30
## Get a single commit
Get a specific commit identified by the commit hash or name of a branch or tag.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/repository/commits/:sha
```
Parameters:
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit hash or name of a repository branch or tag |
2018-03-17 18:26:18 +05:30
| `stats` | boolean | no | Include commit stats. Default is true |
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master"
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
```json
{
"id": "6104942438c14ec7bd21c6cd5bd995272b3faff6",
"short_id": "6104942438c",
"title": "Sanitize for network graph",
"author_name": "randx",
2020-04-08 14:13:33 +05:30
"author_email": "user@example.com",
2017-08-17 22:00:37 +05:30
"committer_name": "Dmitriy",
2020-04-08 14:13:33 +05:30
"committer_email": "user@example.com",
2022-06-21 17:19:12 +05:30
"created_at": "2021-09-20T09:06:12.300+03:00",
2014-09-02 18:07:02 +05:30
"message": "Sanitize for network graph",
2022-06-21 17:19:12 +05:30
"committed_date": "2021-09-20T09:06:12.300+03:00",
"authored_date": "2021-09-20T09:06:12.420+03:00",
2014-09-02 18:07:02 +05:30
"parent_ids": [
"ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
2015-10-24 18:46:33 +05:30
],
2018-03-17 18:26:18 +05:30
"last_pipeline" : {
"id": 8,
"ref": "master",
2019-07-07 11:18:12 +05:30
"sha": "2dc6aa325a317eda67812f05600bdf0fcdc70ab0",
2018-03-17 18:26:18 +05:30
"status": "created"
2019-07-07 11:18:12 +05:30
},
2016-09-13 17:45:13 +05:30
"stats": {
"additions": 15,
"deletions": 10,
"total": 25
},
2020-04-08 14:13:33 +05:30
"status": "running",
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/6104942438c14ec7bd21c6cd5bd995272b3faff6"
2014-09-02 18:07:02 +05:30
}
```
2018-03-27 19:54:05 +05:30
## Get references a commit is pushed to
Get all references (from branches or tags) a commit is pushed to.
The pagination parameters `page` and `per_page` can be used to restrict the list of references.
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-27 19:54:05 +05:30
GET /projects/:id/repository/commits/:sha/refs
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2018-03-27 19:54:05 +05:30
| `sha` | string | yes | The commit hash |
| `type` | string | no | The scope of commits. Possible values `branch`, `tag`, `all`. Default is `all`. |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/5937ac0a7beb003549fc5fd26fc247adbce4a52e/refs?type=all"
2018-03-27 19:54:05 +05:30
```
Example response:
```json
[
{"type": "branch", "name": "'test'"},
{"type": "branch", "name": "add-balsamiq-file"},
{"type": "branch", "name": "wip"},
{"type": "tag", "name": "v1.1.0"}
]
```
2021-11-11 11:23:49 +05:30
## Cherry-pick a commit
2017-08-17 22:00:37 +05:30
2021-11-11 11:23:49 +05:30
Cherry-picks a commit to a given branch.
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/repository/commits/:sha/cherry_pick
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2017-08-17 22:00:37 +05:30
| `sha` | string | yes | The commit hash |
| `branch` | string | yes | The name of the branch |
2020-10-24 23:57:45 +05:30
| `dry_run` | boolean | no | Does not commit any changes. Default is false. [Introduced in GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/231032) |
2021-09-04 01:27:46 +05:30
| `message` | string | no | A custom commit message to use for the new commit. [Introduced in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62481)
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--form "branch=master" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master/cherry_pick"
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"id": "8b090c1b79a14f2bd9e8a738f717824ff53aebad",
"short_id": "8b090c1b",
2020-04-08 14:13:33 +05:30
"author_name": "Example User",
"author_email": "user@example.com",
2017-08-17 22:00:37 +05:30
"authored_date": "2016-12-12T20:10:39.000+01:00",
"created_at": "2016-12-12T20:10:39.000+01:00",
"committer_name": "Administrator",
"committer_email": "admin@example.com",
"committed_date": "2016-12-12T20:10:39.000+01:00",
"title": "Feature added",
2020-04-08 14:13:33 +05:30
"message": "Feature added\n\nSigned-off-by: Example User <user@example.com>\n",
2017-08-17 22:00:37 +05:30
"parent_ids": [
"a738f717824ff53aebad8b090c1b79a14f2bd9e8"
2020-04-08 14:13:33 +05:30
],
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/8b090c1b79a14f2bd9e8a738f717824ff53aebad"
2017-08-17 22:00:37 +05:30
}
```
2021-04-17 20:07:23 +05:30
In the event of a failed cherry-pick, the response provides context about
2019-12-26 22:10:19 +05:30
why:
```json
{
"message": "Sorry, we cannot cherry-pick this commit automatically. This commit may already have been cherry-picked, or a more recent commit may have updated some of its content.",
"error_code": "empty"
}
```
In this case, the cherry-pick failed because the changeset was empty and likely
indicates that the commit already exists in the target branch. The other
possible error code is `conflict`, which indicates that there was a merge
conflict.
2021-04-17 20:07:23 +05:30
When `dry_run` is enabled, the server attempts to apply the cherry-pick _but
2020-10-24 23:57:45 +05:30
not actually commit any resulting changes_. If the cherry-pick applies cleanly,
2021-04-17 20:07:23 +05:30
the API responds with `200 OK`:
2020-10-24 23:57:45 +05:30
```json
{
"dry_run": "success"
}
```
2021-04-17 20:07:23 +05:30
In the event of a failure, an error displays that is identical to a failure without
2020-10-24 23:57:45 +05:30
dry run.
2018-12-13 13:39:08 +05:30
## Revert a commit
Reverts a commit in a given branch.
2020-04-08 14:13:33 +05:30
```plaintext
2018-12-13 13:39:08 +05:30
POST /projects/:id/repository/commits/:sha/revert
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
2018-12-13 13:39:08 +05:30
| `sha` | string | yes | Commit SHA to revert |
| `branch` | string | yes | Target branch name |
2021-11-11 11:23:49 +05:30
| `dry_run` | boolean | no | Does not commit any changes. Default is false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/231032) in GitLab 13.3 |
2018-12-13 13:39:08 +05:30
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "branch=master" \
"https://gitlab.example.com/api/v4/projects/5/repository/commits/a738f717824ff53aebad8b090c1b79a14f2bd9e8/revert"
2018-12-13 13:39:08 +05:30
```
Example response:
```json
{
"id":"8b090c1b79a14f2bd9e8a738f717824ff53aebad",
"short_id": "8b090c1b",
"title":"Revert \"Feature added\"",
"created_at":"2018-11-08T15:55:26.000Z",
"parent_ids":["a738f717824ff53aebad8b090c1b79a14f2bd9e8"],
"message":"Revert \"Feature added\"\n\nThis reverts commit a738f717824ff53aebad8b090c1b79a14f2bd9e8",
"author_name":"Administrator",
"author_email":"admin@example.com",
"authored_date":"2018-11-08T15:55:26.000Z",
"committer_name":"Administrator",
"committer_email":"admin@example.com",
2020-04-08 14:13:33 +05:30
"committed_date":"2018-11-08T15:55:26.000Z",
"web_url": "https://gitlab.example.com/thedude/gitlab-foss/-/commit/8b090c1b79a14f2bd9e8a738f717824ff53aebad"
2018-12-13 13:39:08 +05:30
}
```
2021-04-17 20:07:23 +05:30
In the event of a failed revert, the response provides context about why:
2019-12-26 22:10:19 +05:30
```json
{
"message": "Sorry, we cannot revert this commit automatically. This commit may already have been reverted, or a more recent commit may have updated some of its content.",
"error_code": "conflict"
}
```
In this case, the revert failed because the attempted revert generated a merge
conflict. The other possible error code is `empty`, which indicates that the
changeset was empty, likely due to the change having already been reverted.
2021-04-17 20:07:23 +05:30
When `dry_run` is enabled, the server attempts to apply the revert _but not
2020-10-24 23:57:45 +05:30
actually commit any resulting changes_. If the revert applies cleanly, the API
2021-04-17 20:07:23 +05:30
responds with `200 OK`:
2020-10-24 23:57:45 +05:30
```json
{
"dry_run": "success"
}
```
2021-04-17 20:07:23 +05:30
In the event of a failure, an error displays that is identical to a failure without
2020-10-24 23:57:45 +05:30
dry run.
2014-09-02 18:07:02 +05:30
## Get the diff of a commit
Get the diff of a commit in a project.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/repository/commits/:sha/diff
```
Parameters:
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit hash or name of a repository branch or tag |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master/diff"
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
```json
[
{
2017-08-17 22:00:37 +05:30
"diff": "--- a/doc/update/5.4-to-6.0.md\n+++ b/doc/update/5.4-to-6.0.md\n@@ -71,6 +71,8 @@\n sudo -u git -H bundle exec rake migrate_keys RAILS_ENV=production\n sudo -u git -H bundle exec rake migrate_inline_notes RAILS_ENV=production\n \n+sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production\n+\n ```\n \n ### 6. Update config files",
2014-09-02 18:07:02 +05:30
"new_path": "doc/update/5.4-to-6.0.md",
"old_path": "doc/update/5.4-to-6.0.md",
"a_mode": null,
"b_mode": "100644",
"new_file": false,
"renamed_file": false,
"deleted_file": false
}
]
```
2015-04-26 12:48:37 +05:30
## Get the comments of a commit
Get the comments of a commit in a project.
2020-04-08 14:13:33 +05:30
```plaintext
2015-04-26 12:48:37 +05:30
GET /projects/:id/repository/commits/:sha/comments
```
Parameters:
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit hash or name of a repository branch or tag |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master/comments"
2016-04-02 18:10:28 +05:30
```
Example response:
2015-04-26 12:48:37 +05:30
```json
[
{
"note": "this code is really nice",
"author": {
"id": 11,
"username": "admin",
"email": "admin@local.host",
"name": "Administrator",
"state": "active",
"created_at": "2014-03-06T08:17:35.000Z"
}
}
]
```
## Post comment to commit
2016-04-02 18:10:28 +05:30
Adds a comment to a commit.
2022-03-02 08:16:31 +05:30
To post a comment in a particular line of a particular file, you must specify
the full commit SHA, the `path`, the `line`, and `line_type` should be `new`.
2016-04-02 18:10:28 +05:30
2021-04-17 20:07:23 +05:30
The comment is added at the end of the last commit if at least one of the
2016-04-02 18:10:28 +05:30
cases below is valid:
- the `sha` is instead a branch or a tag and the `line` or `path` are invalid
- the `line` number is invalid (does not exist)
- the `path` is invalid (does not exist)
In any of the above cases, the response of `line`, `line_type` and `path` is
set to `null`.
2015-04-26 12:48:37 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2015-04-26 12:48:37 +05:30
POST /projects/:id/repository/commits/:sha/comments
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit SHA or name of a repository branch or tag |
| `note` | string | yes | The text of the comment |
| `path` | string | no | The file path relative to the repository |
| `line` | integer | no | The line number where the comment should be placed |
| `line_type` | string | no | The line type. Takes `new` or `old` as arguments |
2020-03-13 15:44:24 +05:30
```shell
2021-09-04 01:27:46 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--form "note=Nice picture man\!" --form "path=dudeism.md" --form "line=11" --form "line_type=new" \
"https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/comments"
2016-04-02 18:10:28 +05:30
```
2015-04-26 12:48:37 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2015-04-26 12:48:37 +05:30
```json
{
2016-04-02 18:10:28 +05:30
"author" : {
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/thedude",
2016-04-02 18:10:28 +05:30
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png",
"username" : "thedude",
"state" : "active",
"name" : "Jeff Lebowski",
"id" : 28
},
"created_at" : "2016-01-19T09:44:55.600Z",
"line_type" : "new",
"path" : "dudeism.md",
"line" : 11,
"note" : "Nice picture man!"
2015-04-26 12:48:37 +05:30
}
```
2015-10-24 18:46:33 +05:30
2020-05-24 23:13:21 +05:30
## Get the discussions of a commit
Get the discussions of a commit in a project.
```plaintext
GET /projects/:id/repository/commits/:sha/discussions
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2020-05-24 23:13:21 +05:30
| `sha` | string | yes | The commit hash or name of a repository branch or tag |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/4604744a1c64de00ff62e1e8a6766919923d2b41/discussions"
```
Example response:
```json
[
{
"id": "4604744a1c64de00ff62e1e8a6766919923d2b41",
"individual_note": true,
"notes": [
{
"id": 334686748,
"type": null,
"body": "I'm the Dude, so that's what you call me.",
"attachment": null,
"author" : {
"id" : 28,
"name" : "Jeff Lebowski",
"username" : "thedude",
"web_url" : "https://gitlab.example.com/thedude",
"state" : "active",
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png"
},
"created_at": "2020-04-30T18:48:11.432Z",
"updated_at": "2020-04-30T18:48:11.432Z",
"system": false,
"noteable_id": null,
"noteable_type": "Commit",
"resolvable": false,
"confidential": null,
"noteable_iid": null,
"commands_changes": {}
}
]
}
]
```
2016-04-02 18:10:28 +05:30
## Commit status
2021-11-18 22:05:49 +05:30
This is the commit status API for use with GitLab.
2016-04-02 18:10:28 +05:30
2018-05-09 12:01:36 +05:30
### List the statuses of a commit
2015-10-24 18:46:33 +05:30
2018-05-09 12:01:36 +05:30
List the statuses of a commit in a project.
The pagination parameters `page` and `per_page` can be used to restrict the list of references.
2015-10-24 18:46:33 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2015-10-24 18:46:33 +05:30
GET /projects/:id/repository/commits/:sha/statuses
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit SHA
2016-11-03 12:29:30 +05:30
| `ref` | string | no | The name of a repository branch or tag or, if not given, the default branch
2021-09-30 23:02:18 +05:30
| `stage` | string | no | Filter by [build stage](../ci/yaml/index.md#stages), for example, `test`
| `name` | string | no | Filter by [job name](../ci/yaml/index.md#job-keywords), for example, `bundler:audit`
2016-04-02 18:10:28 +05:30
| `all` | boolean | no | Return all statuses, not only the latest ones
2020-03-13 15:44:24 +05:30
```shell
2021-02-22 17:27:13 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/statuses"
2016-04-02 18:10:28 +05:30
```
2015-10-24 18:46:33 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2015-10-24 18:46:33 +05:30
```json
[
2016-04-02 18:10:28 +05:30
...
{
"status" : "pending",
"created_at" : "2016-01-19T08:40:25.934Z",
"started_at" : null,
"name" : "bundler:audit",
"allow_failure" : true,
"author" : {
"username" : "thedude",
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/thedude",
2016-04-02 18:10:28 +05:30
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png",
"id" : 28,
"name" : "Jeff Lebowski"
},
"description" : null,
"sha" : "18f3e63d05582537db6d183d9d557be09e1f90c8",
2019-12-21 20:55:43 +05:30
"target_url" : "https://gitlab.example.com/thedude/gitlab-foss/builds/91",
2016-04-02 18:10:28 +05:30
"finished_at" : null,
"id" : 91,
"ref" : "master"
},
{
"started_at" : null,
2018-11-20 20:47:30 +05:30
"name" : "test",
2016-04-02 18:10:28 +05:30
"allow_failure" : false,
"status" : "pending",
"created_at" : "2016-01-19T08:40:25.832Z",
2019-12-21 20:55:43 +05:30
"target_url" : "https://gitlab.example.com/thedude/gitlab-foss/builds/90",
2016-04-02 18:10:28 +05:30
"id" : 90,
"finished_at" : null,
"ref" : "master",
"sha" : "18f3e63d05582537db6d183d9d557be09e1f90c8",
"author" : {
"id" : 28,
"name" : "Jeff Lebowski",
"username" : "thedude",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/thedude",
2016-04-02 18:10:28 +05:30
"state" : "active",
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png"
},
"description" : null
},
...
2015-10-24 18:46:33 +05:30
]
```
2016-04-02 18:10:28 +05:30
### Post the build status to a commit
2015-10-24 18:46:33 +05:30
2016-04-02 18:10:28 +05:30
Adds or updates a build status of a commit.
2015-10-24 18:46:33 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2015-10-24 18:46:33 +05:30
POST /projects/:id/statuses/:sha
```
2016-04-02 18:10:28 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2016-04-02 18:10:28 +05:30
| `sha` | string | yes | The commit SHA
| `state` | string | yes | The state of the status. Can be one of the following: `pending`, `running`, `success`, `failed`, `canceled`
| `ref` | string | no | The `ref` (branch or tag) to which the status refers
| `name` or `context` | string | no | The label to differentiate this status from the status of other systems. Default value is `default`
| `target_url` | string | no | The target URL to associate with this status
| `description` | string | no | The short description of the status
2017-08-17 22:00:37 +05:30
| `coverage` | float | no | The total code coverage
2019-10-12 21:52:04 +05:30
| `pipeline_id` | integer | no | The ID of the pipeline to set status. Use in case of several pipeline on same SHA.
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/17/statuses/18f3e63d05582537db6d183d9d557be09e1f90c8?state=success"
2016-04-02 18:10:28 +05:30
```
Example response:
2015-10-24 18:46:33 +05:30
```json
{
2016-04-02 18:10:28 +05:30
"author" : {
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/thedude",
2016-04-02 18:10:28 +05:30
"name" : "Jeff Lebowski",
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png",
"username" : "thedude",
"state" : "active",
"id" : 28
},
"name" : "default",
"sha" : "18f3e63d05582537db6d183d9d557be09e1f90c8",
"status" : "success",
2017-08-17 22:00:37 +05:30
"coverage": 100.0,
2016-04-02 18:10:28 +05:30
"description" : null,
"id" : 93,
"target_url" : null,
"ref" : null,
"started_at" : null,
"created_at" : "2016-01-19T09:05:50.355Z",
"allow_failure" : false,
"finished_at" : "2016-01-19T09:05:50.365Z"
2015-10-24 18:46:33 +05:30
}
```
2016-11-03 12:29:30 +05:30
2022-04-04 11:22:00 +05:30
## List merge requests associated with a commit
2018-05-09 12:01:36 +05:30
2022-04-04 11:22:00 +05:30
Get a list of merge requests related to the specified commit.
2018-05-09 12:01:36 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-05-09 12:01:36 +05:30
GET /projects/:id/repository/commits/:sha/merge_requests
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2018-05-09 12:01:36 +05:30
| `sha` | string | yes | The commit SHA
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/af5b13261899fb2c0db30abdd0af8b07cb44fdc5/merge_requests"
2018-05-09 12:01:36 +05:30
```
Example response:
```json
[
{
"id":45,
"iid":1,
"project_id":35,
"title":"Add new file",
"description":"",
"state":"opened",
"created_at":"2018-03-26T17:26:30.916Z",
"updated_at":"2018-03-26T17:26:30.916Z",
"target_branch":"master",
"source_branch":"test-branch",
"upvotes":0,
"downvotes":0,
"author" : {
"web_url" : "https://gitlab.example.com/thedude",
"name" : "Jeff Lebowski",
"avatar_url" : "https://gitlab.example.com/uploads/user/avatar/28/The-Big-Lebowski-400-400.png",
"username" : "thedude",
"state" : "active",
"id" : 28
},
"assignee":null,
"source_project_id":35,
"target_project_id":35,
"labels":[ ],
2021-09-04 01:27:46 +05:30
"draft":false,
2018-05-09 12:01:36 +05:30
"work_in_progress":false,
"milestone":null,
"merge_when_pipeline_succeeds":false,
"merge_status":"can_be_merged",
"sha":"af5b13261899fb2c0db30abdd0af8b07cb44fdc5",
"merge_commit_sha":null,
2019-12-26 22:10:19 +05:30
"squash_commit_sha":null,
2018-05-09 12:01:36 +05:30
"user_notes_count":0,
"discussion_locked":null,
"should_remove_source_branch":null,
"force_remove_source_branch":false,
2022-07-23 23:45:48 +05:30
"web_url":"https://gitlab.example.com/root/test-project/merge_requests/1",
2018-05-09 12:01:36 +05:30
"time_stats":{
"time_estimate":0,
"total_time_spent":0,
"human_time_estimate":null,
"human_total_time_spent":null
}
}
]
```
2019-07-07 11:18:12 +05:30
## Get GPG signature of a commit
Get the [GPG signature from a commit](../user/project/repository/gpg_signed_commits/index.md),
if it is signed. For unsigned commits, it results in a 404 response.
2020-04-08 14:13:33 +05:30
```plaintext
2019-07-07 11:18:12 +05:30
GET /projects/:id/repository/commits/:sha/signature
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user
2019-07-07 11:18:12 +05:30
| `sha` | string | yes | The commit hash or name of a repository branch or tag |
2020-03-13 15:44:24 +05:30
```shell
2019-07-07 11:18:12 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/repository/commits/da738facbc19eb2fc2cef57c49be0e6038570352/signature"
```
2020-04-22 19:07:51 +05:30
Example response if commit is GPG signed:
2019-07-07 11:18:12 +05:30
```json
{
2020-04-22 19:07:51 +05:30
"signature_type": "PGP",
"verification_status": "verified",
2019-07-07 11:18:12 +05:30
"gpg_key_id": 1,
"gpg_key_primary_keyid": "8254AAB3FBD54AC9",
"gpg_key_user_name": "John Doe",
"gpg_key_user_email": "johndoe@example.com",
2021-01-29 00:20:46 +05:30
"gpg_key_subkey_id": null,
"commit_source": "gitaly"
2019-07-07 11:18:12 +05:30
}
```
2020-05-24 23:13:21 +05:30
Example response if commit is X.509 signed:
2020-04-22 19:07:51 +05:30
```json
{
"signature_type": "X509",
"verification_status": "unverified",
"x509_certificate": {
"id": 1,
"subject": "CN=gitlab@example.org,OU=Example,O=World",
"subject_key_identifier": "BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC:BC",
"email": "gitlab@example.org",
"serial_number": 278969561018901340486471282831158785578,
"certificate_status": "good",
"x509_issuer": {
"id": 1,
"subject": "CN=PKI,OU=Example,O=World",
"subject_key_identifier": "AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB:AB",
"crl_url": "http://example.com/pki.crl"
}
2021-01-29 00:20:46 +05:30
},
"commit_source": "gitaly"
2020-04-22 19:07:51 +05:30
}
```
2019-07-07 11:18:12 +05:30
Example response if commit is unsigned:
2019-09-30 21:07:59 +05:30
2019-07-07 11:18:12 +05:30
```json
{
"message": "404 GPG Signature Not Found"
}
```