Functions

create-pull

fn (owner: Str, repo: Str, title: Str, head: Str, base: Str): Map
fn (owner: Str, repo: Str, title: Str, head: Str, base: Str, options: Map): Map
fn (owner: Str, repo: Str, title: Str, head: Str, base: Str, options: Map, opts: Map): Map

POST /repos/{owner}/{repo}/pulls - Open a pull request. options: body, draft, maintainer_can_modify.

Example

pr ::github::pulls/create-pull("acme", "api", "Add rate limiting", "feature/rate-limit", "main", {
  body: "Implements token-bucket limiting.",
  draft: true
})
pr.number

create-review

fn (owner: Str, repo: Str, number: Int, review: Map): Map
fn (owner: Str, repo: Str, number: Int, review: Map, opts: Map): Map
fn (owner: Str, repo: Str, number: Int, event: Str, body: Str): Map
fn (owner: Str, repo: Str, number: Int, event: Str, body: Str, opts: Map): Map

POST /repos/{owner}/{repo}/pulls/{number}/reviews - Review a PR.

The Map form supports commit_id, body, event ("APPROVE", "REQUEST_CHANGES", or "COMMENT"), and an inline comments Vec. The event/body form remains as a concise summary-review convenience.

Example

::github::pulls/create-review("acme", "api", 68, "APPROVE", "Looks good.")

// Map form, with an inline comment
::github::pulls/create-review("acme", "api", 68, {
  event: "COMMENT",
  body: "One question.",
  comments: [{path: "src/limit.hot", line: 12, side: "RIGHT", body: "Why 60?"}]
})

get-pull

fn (owner: Str, repo: Str, number: Int): Map
fn (owner: Str, repo: Str, number: Int, opts: Map): Map

GET /repos/{owner}/{repo}/pulls/{number} - One pull request (mergeability, head/base, diff stats).

Example

pr ::github::pulls/get-pull("acme", "api", 68)
pr.mergeable

get-review

fn (owner: Str, repo: Str, number: Int, review-id: Any): Map
fn (owner: Str, repo: Str, number: Int, review-id: Any, opts: Map): Map

GET /repos/{owner}/{repo}/pulls/{number}/reviews/{review_id} - One pull-request review.

Example

review ::github::pulls/get-review("acme", "api", 68, 9001)
review.body

list-files

fn (owner: Str, repo: Str, number: Int): Vec
fn (owner: Str, repo: Str, number: Int, params: Map): Vec
fn (owner: Str, repo: Str, number: Int, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls/{number}/files - The files changed by a pull request (filename, status, additions/deletions, patch). params supports per_page, page. Returns a single page (GitHub default 30, max 100); pass page to paginate.

Example

changed ::github::pulls/list-files("acme", "api", 68, {per_page: 100})
map(changed, %.filename)

list-pull-commits

fn (owner: Str, repo: Str, number: Int): Vec
fn (owner: Str, repo: Str, number: Int, params: Map): Vec
fn (owner: Str, repo: Str, number: Int, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls/{number}/commits - Commits in a pull request, in chronological order. params supports per_page and page. GitHub caps this endpoint at 250 commits.

Example

commits ::github::pulls/list-pull-commits("acme", "api", 68)
map(commits, %.sha)

list-pulls

fn (owner: Str, repo: Str): Vec
fn (owner: Str, repo: Str, params: Map): Vec
fn (owner: Str, repo: Str, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls - List pull requests. params supports state, head, base, sort, per_page, page. Returns a single page (GitHub default 30, max 100); pass page to paginate.

Example

pulls ::github::pulls/list-pulls("acme", "api", {state: "open", base: "main"})
map(pulls, %.number)

list-requested-reviewers

fn (owner: Str, repo: Str, number: Int): Map
fn (owner: Str, repo: Str, number: Int, opts: Map): Map

GET /repos/{owner}/{repo}/pulls/{number}/requested_reviewers - Users and teams whose review is still requested.

Example

pending ::github::pulls/list-requested-reviewers("acme", "api", 68)
map(pending.users, %.login)

list-review-comments

fn (owner: Str, repo: Str, number: Int): Vec
fn (owner: Str, repo: Str, number: Int, params: Map): Vec
fn (owner: Str, repo: Str, number: Int, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls/{number}/comments - Inline review comments across all reviews. params supports sort, direction, since, per_page, and page.

Example

comments ::github::pulls/list-review-comments("acme", "api", 68, {sort: "created", direction: "desc"})
map(comments, %.path)

list-review-comments-for-review

fn (owner: Str, repo: Str, number: Int, review-id: Any): Vec
fn (owner: Str, repo: Str, number: Int, review-id: Any, params: Map): Vec
fn (owner: Str, repo: Str, number: Int, review-id: Any, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls/{number}/reviews/{review_id}/comments - Inline comments belonging to one review. params supports per_page and page.

Example

comments ::github::pulls/list-review-comments-for-review("acme", "api", 68, 9001)
map(comments, %.body)

list-reviews

fn (owner: Str, repo: Str, number: Int): Vec
fn (owner: Str, repo: Str, number: Int, params: Map): Vec
fn (owner: Str, repo: Str, number: Int, params: Map, opts: Map): Vec

GET /repos/{owner}/{repo}/pulls/{number}/reviews - Submitted and pending reviews in chronological order. params supports per_page and page.

Example

reviews ::github::pulls/list-reviews("acme", "api", 68)
map(reviews, %.state)

merge-pull

fn (owner: Str, repo: Str, number: Int): Map
fn (owner: Str, repo: Str, number: Int, options: Map): Map
fn (owner: Str, repo: Str, number: Int, options: Map, opts: Map): Map

PUT /repos/{owner}/{repo}/pulls/{number}/merge - Merge a PR. options: merge_method ("merge"/"squash"/"rebase"), commit_title, commit_message.

Example

merged ::github::pulls/merge-pull("acme", "api", 68, {merge_method: "squash"})
merged.sha

request-reviewers

fn (owner: Str, repo: Str, number: Int, reviewers: Vec): Map
fn (owner: Str, repo: Str, number: Int, reviewers: Vec, opts: Map): Map

POST /repos/{owner}/{repo}/pulls/{number}/requested_reviewers - Request reviews from users.

Example

::github::pulls/request-reviewers("acme", "api", 68, ["octocat"])

update-pull

fn (owner: Str, repo: Str, number: Int, changes: Map): Map
fn (owner: Str, repo: Str, number: Int, changes: Map, opts: Map): Map

PATCH /repos/{owner}/{repo}/pulls/{number} - Update a pull request. changes supports title, body, state, base, and maintainer_can_modify.

Example

::github::pulls/update-pull("acme", "api", 68, {title: "Add rate limiting", state: "open"})