eamonnsullivan.github-api-lib.pull-requests — eamonnsullivan/github-api-lib 0.1.17

add-pull-request-comment clj

(add-pull-request-comment access-token pull-request-url comment-body)

Add a top-level comment to a pull request.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.
• comment-body -- the comment to add.

Returns information about the comment, including its :url and :body.

close-pull-request clj

(close-pull-request access-token pull-request-url)

Change the status of a pull request to closed.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.

create-pr-defaults clj

create-pull-request clj

(create-pull-request access-token pull-request)

(create-pull-request access-token url pull-request)

Create a pull request on Github repository.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• url -- the URL of the repo (optional). The URL can omit the https://github.com/, e.g. owner/repo-name.
• pull-request -- a map describing the pull request. Keys: :title, :base (the base branch), :branch (the branch you want to merge) and (if a URL isn't provided) the :owner (or organisation) and :name of the repo. Optional key :draft (default: true) indicates whether the pull request is in a draft state and not ready for review.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.

edit-pull-request-comment clj

(edit-pull-request-comment access-token comment-url comment-body)

Changes the body of a comment.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• comment-url -- e.g., the full (e.g., https://github.com/owner/name/pull/4#issuecomment-702092682) or partial (owner/name/pull/4#issuecomment-702092682) URL of the comment.
• comment-body -- the new body of the comment.

Returns information about the comment, including its :url and :body.

get-comment-node-id clj

(get-comment-node-id access-token owner repo comment-number)

Get the node id of a pull request comment using the v3 REST API.

get-issue-comment-id clj

(get-issue-comment-id access-token comment-url)

Find the unique ID of an issue comment on a pull request. Returns nil if not found.

get-pull-request-id clj

(get-pull-request-id access-token url)

(get-pull-request-id access-token url must-be-open?)

Find the unique ID of a pull request on the repository at the provided url. Set must-be-open? to true to filter the pull requests to those with a status of open. Throws a runtime exception if the pull request isn't found.

get-pull-request-info clj

(get-pull-request-info access-token pull-request-url)

Find some info about a pull request. Available properties: :id, :title, :body, :baseRefOid, :headRefOid, :permalink, :author (:login, :url), :closed, :isDraft, :merged, :mergeable (MERGEABLE, CONFLICTING or UNKNOWN), :number, :repository (:id, :url), :state (CLOSED, MERGED or OPEN).

get-pull-request-node-id clj

(get-pull-request-node-id access-token owner repo-name pull-number state)

Get the node id of a pull request using the v3 REST api, optionally filtered by state ("open", "closed", or the default of "all")

mark-ready-for-review clj

(mark-ready-for-review access-token pull-request-url)

Mark a pull request as ready for review.

This effectively just toggles the :draft property of the pull request to false.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.

merge-pull-request clj

(merge-pull-request access-token pull-request-url)

(merge-pull-request access-token pull-request-url merge-options)

Merge a pull request.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.
• merge-options -- a map with keys that can include :title (the headline of the commit), :body (any body description of the commit), :mergeMethod (default "SQUASH", but can also be "MERGE" or "REBASE") and :authorEmail. All of these input fields are optional.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.

modify-comment clj

(modify-comment access-token url mutation variables)

Modify a comment at the url with the provided mutation and variables.

modify-pull-request clj

(modify-pull-request access-token url mutation)

(modify-pull-request access-token url mutation variables)

Modify a pull request at the url with the provided mutation.

reopen-pull-request clj

(reopen-pull-request access-token pull-request-url)

Change the status of a pull request to open.

Arguments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.

update-pull-request clj

(update-pull-request access-token pull-request-url updated)

Update an existing pull request.

Argments:

• access-token -- the Github access token to use. Must have repo permissions.
• pull-request-url -- the full (e.g., https://github.com/owner/name/pull/1) or partial (owner/name/pull/1) URL of the pull request.
• updated -- a map describing the update. The keys: :title, :body.

Returns a map describing the pull request, including :title, :body, :permalink, :additions, :deletions and :revertUrl.