Liking cljdoc? Tell your friends :D

eamonnsullivan.github-pr-lib


*search-page-size*clj

source

add-comment-mutationclj

source

add-pull-request-commentclj

(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 the comment's permanent URL.

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 the comment's permanent URL.
sourceraw docstring

close-pull-requestclj

(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.

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.
sourceraw docstring

close-pull-request-mutationclj

source

create-pr-defaultsclj

source

create-pull-requestclj

(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 keys include :draft (default: true), indicating whether the pull request is ready for review and :maintainerCanModify (default: true) indicating whether the repo owner is allowed to modify the pull request.

Returns the pull request's permanent URL.

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 keys
include :draft (default: true), indicating whether the pull request
is ready for review and :maintainerCanModify (default: true)
indicating whether the repo owner is allowed to modify the pull
request.

Returns the pull request's permanent URL.
sourceraw docstring

create-pull-request-mutationclj

source

edit-comment-mutationclj

source

edit-pull-request-commentclj

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

Changes the body of a comment

Arguments:

Returns the comment's permanent URL.

Changes the body of a comment

Arguments:
* access-token -- the Github access token to use.

* 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 the comment's permanent URL.
sourceraw docstring

get-issue-comment-idclj

(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.

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

get-open-pr-idclj

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

Find the unique ID of an open pull request. Returns nil of none are found.

Find the unique ID of an open pull request. Returns nil of none are found.
sourceraw docstring

get-page-of-issue-commentsclj

(get-page-of-issue-comments access-token pull-request-id page-size cursor)

Get a page of issues comments on a particular pull request

Get a page of issues comments on a particular pull request
sourceraw docstring

get-page-of-pull-requestsclj

(get-page-of-pull-requests access-token owner name page-size cursor)
(get-page-of-pull-requests access-token owner name page-size cursor open?)

Get a page of pull requests, optionally (and by default) filtered by those with a status of open.

Get a page of pull requests, optionally (and by default) filtered by
those with a status of open.
sourceraw docstring

get-pull-request-idclj

(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. Returns nil if not found.

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. Returns nil if not found.
sourceraw docstring

get-pull-request-infoclj

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

Find some info about a pull request.

Find some info about a pull request.
sourceraw docstring

get-repo-idclj

(get-repo-id access-token url)
(get-repo-id access-token owner repo-name)

Get the unique ID value for a repository.

Get the unique ID value for a repository.
sourceraw docstring

get-repo-id-queryclj

source

github-urlclj

source

http-postclj

(http-post url payload opts)

Make a POST request to a url with body payload and request options.

Make a POST request to a url with body payload and request options.
sourceraw docstring

make-graphql-postclj

(make-graphql-post access-token graphql variables)

Make a GraphQL request to Github using the provided query/mutation and variables. If there are any errors, throw a RuntimeException, with the message set to the first error and the rest of the response as the cause/additional information.

Make a GraphQL request to Github using the provided query/mutation
and variables. If there are any errors, throw a RuntimeException,
with the message set to the first error and the rest of the response
as the cause/additional information.
sourceraw docstring

mark-ready-for-reviewclj

(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 the pull request's permanent 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 the pull request's permanent URL.
sourceraw docstring

mark-ready-for-review-mutationclj

source

merge-pull-requestclj

(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 fields are optional.

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 fields are optional.
sourceraw docstring

merge-pull-request-mutationclj

source

modify-commentclj

(modify-comment access-token url mutation variables)

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

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

modify-pull-requestclj

(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.

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

parse-comment-urlclj

(parse-comment-url comment-url)

Get the full comment url and pull request url from an issue comment URL.

Get the full comment url and pull request url from an issue comment URL.
sourceraw docstring

parse-repoclj

(parse-repo url)

Parse a repository url (a full url or just the owner/name part) and return a map with :owner and :name keys.

Parse a repository url (a full url or just the owner/name part) and
return a map with :owner and :name keys.
sourceraw docstring

pull-request-numberclj

(pull-request-number pull-request-url)

Get the pull request number from a full or partial URL.

Get the pull request number from a full or partial URL.
sourceraw docstring

pull-request-queryclj

source

reopen-pull-requestclj

(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.

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.
sourceraw docstring

reopen-pull-request-mutationclj

source

request-optsclj

(request-opts access-token)

Add the authorization header to the http request options.

Add the authorization header to the http request options.
sourceraw docstring

search-for-issue-comment-idclj

source

search-for-pr-id-queryclj

source

update-pull-requestclj

(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 the pull request's permanent URL.

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 the pull request's permanent URL.
sourceraw docstring

update-pull-request-mutationclj

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close