Add a pull request to an application's merge train

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries"

payload = { "pull_request_number": 2 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pull_request_number: 2})
};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pull_request_number": 2
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pull_request_number": 123,
  "pull_request_head_sha": "<string>",
  "pull_request_title": "<string>",
  "base_branch": "<string>",
  "status": "queued",
  "position": 123,
  "attempt": 123,
  "requested_by": "<string>",
  "requested_via": "api",
  "enqueued_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "car_branch": "<string>",
  "car_base_sha": "<string>",
  "car_commit_sha": "<string>",
  "car_tree_sha": "<string>",
  "predecessor_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merge_commit_sha": "<string>",
  "merge_tree_matches": true,
  "reason": "<string>",
  "reason_text": "<string>",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pull_request_number": 123,
  "pull_request_head_sha": "<string>",
  "pull_request_title": "<string>",
  "base_branch": "<string>",
  "status": "queued",
  "position": 123,
  "attempt": 123,
  "requested_by": "<string>",
  "requested_via": "api",
  "enqueued_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "car_branch": "<string>",
  "car_base_sha": "<string>",
  "car_commit_sha": "<string>",
  "car_tree_sha": "<string>",
  "predecessor_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merge_commit_sha": "<string>",
  "merge_tree_matches": true,
  "reason": "<string>",
  "reason_text": "<string>",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Pipelines

Add a pull request to an application's merge train

Puts a pull request at the end of the repository’s merge train. Ankra tests it squashed onto the base branch and the pull requests ahead of it, exactly as the merge will land, and merges it through the host’s own merge when that run passes. A pull request already in the train answers its entry with 200. Addressed by application: the merge train of the pipeline repository the application is connected to. Must be called by a person, not a service account token. Requires pipelines.operate.

POST

api

org

applications

{application_id}

merge-train

entries

Add a pull request to an application's merge train

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries"

payload = { "pull_request_number": 2 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pull_request_number: 2})
};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://platform.ankra.app/api/v1/org/applications/{application_id}/merge-train/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pull_request_number": 2
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pull_request_number": 123,
  "pull_request_head_sha": "<string>",
  "pull_request_title": "<string>",
  "base_branch": "<string>",
  "status": "queued",
  "position": 123,
  "attempt": 123,
  "requested_by": "<string>",
  "requested_via": "api",
  "enqueued_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "car_branch": "<string>",
  "car_base_sha": "<string>",
  "car_commit_sha": "<string>",
  "car_tree_sha": "<string>",
  "predecessor_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merge_commit_sha": "<string>",
  "merge_tree_matches": true,
  "reason": "<string>",
  "reason_text": "<string>",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pull_request_number": 123,
  "pull_request_head_sha": "<string>",
  "pull_request_title": "<string>",
  "base_branch": "<string>",
  "status": "queued",
  "position": 123,
  "attempt": 123,
  "requested_by": "<string>",
  "requested_via": "api",
  "enqueued_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "car_branch": "<string>",
  "car_base_sha": "<string>",
  "car_commit_sha": "<string>",
  "car_tree_sha": "<string>",
  "predecessor_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merge_commit_sha": "<string>",
  "merge_tree_matches": true,
  "reason": "<string>",
  "reason_text": "<string>",
  "detail": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id

string<uuid>

required

Body

application/json

pull_request_number

integer

required

Required range: x >= 1

head_sha

string

Pins the head the train tests and merges. Omitted pins the head the train reads first; a later push to the pull request takes it out of the train.

Pattern: ^([a-f0-9]{40}|[a-f0-9]{64})$

Response

The pull request was already in the train.

string<uuid>

required

pull_request_number

integer

required

pull_request_head_sha

string

required

The head the train tests and merges; empty until the train first reads the pull request.

pull_request_title

string

required

base_branch

string

required

status

enum<string>

required

Available options:

queued,

building,

testing,

passed,

merging,

merged,

evicted,

cancelled

position

integer

required

Order in the train; lower merges first.

attempt

integer

required

How many cars were built for this pull request.

requested_by

string

required

requested_via

enum<string>

required

Available options:

api,

comment,

portal,

tool

enqueued_at

string<date-time>

required

updated_at

string<date-time>

required

car_branch

string | null

car_base_sha

string | null

Pattern: ^[a-f0-9]{40}$

car_commit_sha

string | null

Pattern: ^[a-f0-9]{40}$

car_tree_sha

string | null

Pattern: ^[a-f0-9]{40}$

predecessor_entry_id

string<uuid> | null

pipeline_run_id

string<uuid> | null

The merge_train run testing the car.

merge_commit_sha

string | null

Pattern: ^[a-f0-9]{40}$

merge_tree_matches

boolean | null

Whether the merge landed as exactly the tree the car tested.

reason

string | null

reason_text

string | null

detail

string | null

started_at

string<date-time> | null

finished_at

string<date-time> | null

API reference

Endpoints

Add a pull request to an application's merge train

Authorizations

Path Parameters

Body

Response