View Source GitHub.Pulls (GitHub REST API Client v0.3.3)

Provides API endpoints related to pulls

Link to this section Summary

Functions

Check if a pull request has been merged

Create a review comment for a pull request

Delete a review comment for a pull request

Get a review comment for a pull request

List pull requests

Get all requested reviewers for a pull request

List review comments on a pull request

List review comments in a repository

List reviews for a pull request

Remove requested reviewers from a pull request

Update a review comment for a pull request

Link to this section Types

@type merge_405_json_resp() :: %{
  __info__: map(),
  documentation_url: String.t() | nil,
  message: String.t() | nil
}
@type merge_409_json_resp() :: %{
  __info__: map(),
  documentation_url: String.t() | nil,
  message: String.t() | nil
}
Link to this type

update_branch_202_json_resp()

View Source
@type update_branch_202_json_resp() :: %{
  __info__: map(),
  message: String.t() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

check_if_merged(owner, repo, pull_number, opts \\ [])

View Source
@spec check_if_merged(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Check if a pull request has been merged

Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.

resources

Resources

Link to this function

create(owner, repo, body, opts \\ [])

View Source
@spec create(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}

Create a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.

resources

Resources

Link to this function

create_reply_for_review_comment(owner, repo, pull_number, comment_id, body, opts \\ [])

View Source
@spec create_reply_for_review_comment(
  String.t(),
  String.t(),
  integer(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}

Create a reply for a review comment

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

create_review(owner, repo, pull_number, body, opts \\ [])

View Source
@spec create_review(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Create a review for a pull request

Creates a review on a specified pull request.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see "Submit a review for a pull request."

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

create_review_comment(owner, repo, pull_number, body, opts \\ [])

View Source
@spec create_review_comment(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}

Create a review comment for a pull request

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "Create an issue comment."

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

delete_pending_review(owner, repo, pull_number, review_id, opts \\ [])

View Source
@spec delete_pending_review(String.t(), String.t(), integer(), integer(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Delete a pending review for a pull request

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

delete_review_comment(owner, repo, comment_id, opts \\ [])

View Source
@spec delete_review_comment(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a review comment for a pull request

Deletes a review comment.

resources

Resources

Link to this function

dismiss_review(owner, repo, pull_number, review_id, body, opts \\ [])

View Source
@spec dismiss_review(String.t(), String.t(), integer(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Dismiss a review for a pull request

Dismisses a specified review on a pull request.

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

get(owner, repo, pull_number, opts \\ [])

View Source
@spec get(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}

Get a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests".

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.

Pass the appropriate media type to fetch diff and patch formats.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.

resources

Resources

Link to this function

get_review(owner, repo, pull_number, review_id, opts \\ [])

View Source
@spec get_review(String.t(), String.t(), integer(), integer(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Get a review for a pull request

Retrieves a pull request review by its ID.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

get_review_comment(owner, repo, comment_id, opts \\ [])

View Source
@spec get_review_comment(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}

Get a review comment for a pull request

Provides details for a specified review comment.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

list(owner, repo, opts \\ [])

View Source
@spec list(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.PullRequest.simple()]} | {:error, GitHub.Error.t()}

List pull requests

Lists pull requests in a specified repository.

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
  • application/vnd.github.patch: For more information, see "git-format-patch" in the Git documentation.

options

Options

  • state: Either open, closed, or all to filter by state.
  • head: Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.
  • base: Filter pulls by base branch name. Example: gh-pages.
  • sort: What to sort results by. popularity will sort by the number of comments. long-running will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.
  • direction: The direction of the sort. Default: desc when sort is created or sort is not specified, otherwise asc.
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources

Resources

Link to this function

list_comments_for_review(owner, repo, pull_number, review_id, opts \\ [])

View Source
@spec list_comments_for_review(
  String.t(),
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, [GitHub.ReviewComment.t()]} | {:error, GitHub.Error.t()}

List comments for a pull request review

Lists comments for a specific pull request review.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

options

Options

resources

Resources

Link to this function

list_commits(owner, repo, pull_number, opts \\ [])

View Source
@spec list_commits(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.Commit.t()]} | {:error, GitHub.Error.t()}

List commits on a pull request

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.

options

Options

resources

Resources

Link to this function

list_files(owner, repo, pull_number, opts \\ [])

View Source
@spec list_files(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.DiffEntry.t()]} | {:error, GitHub.Error.t()}

List pull requests files

Lists the files in a specified pull request.

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.

options

Options

resources

Resources

Link to this function

list_requested_reviewers(owner, repo, pull_number, opts \\ [])

View Source
@spec list_requested_reviewers(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.PullRequest.ReviewRequest.t()} | {:error, GitHub.Error.t()}

Get all requested reviewers for a pull request

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

resources

Resources

Link to this function

list_review_comments(owner, repo, pull_number, opts \\ [])

View Source
@spec list_review_comments(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.PullRequest.ReviewComment.t()]} | {:error, GitHub.Error.t()}

List review comments on a pull request

Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

options

Options

  • sort: The property to sort the results by.
  • direction: The direction to sort results. Ignored without sort parameter.
  • since: Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources

Resources

Link to this function

list_review_comments_for_repo(owner, repo, opts \\ [])

View Source
@spec list_review_comments_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.PullRequest.ReviewComment.t()]} | {:error, GitHub.Error.t()}

List review comments in a repository

Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

options

Options

  • sort
  • direction: The direction to sort results. Ignored without sort parameter.
  • since: Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
  • per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  • page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources

Resources

Link to this function

list_reviews(owner, repo, pull_number, opts \\ [])

View Source
@spec list_reviews(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.PullRequest.Review.t()]} | {:error, GitHub.Error.t()}

List reviews for a pull request

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

options

Options

resources

Resources

Link to this function

merge(owner, repo, pull_number, body, opts \\ [])

View Source
@spec merge(String.t(), String.t(), integer(), map() | nil, keyword()) ::
  {:ok, GitHub.PullRequest.MergeResult.t()} | {:error, GitHub.Error.t()}

Merge a pull request

Merges a pull request into the base branch. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

resources

Resources

Link to this function

remove_requested_reviewers(owner, repo, pull_number, body, opts \\ [])

View Source
@spec remove_requested_reviewers(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.simple()} | {:error, GitHub.Error.t()}

Remove requested reviewers from a pull request

Removes review requests from a pull request for a given set of users and/or teams.

resources

Resources

Link to this function

request_reviewers(owner, repo, pull_number, body, opts \\ [])

View Source
@spec request_reviewers(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.simple()} | {:error, GitHub.Error.t()}

Request reviewers for a pull request

Requests reviews for a pull request from a given set of users and/or teams. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

resources

Resources

Link to this function

submit_review(owner, repo, pull_number, review_id, body, opts \\ [])

View Source
@spec submit_review(String.t(), String.t(), integer(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Submit a review for a pull request

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "Create a review for a pull request."

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

update(owner, repo, pull_number, body, opts \\ [])

View Source
@spec update(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}

Update a pull request

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.

resources

Resources

Link to this function

update_branch(owner, repo, pull_number, body, opts \\ [])

View Source
@spec update_branch(String.t(), String.t(), integer(), map() | nil, keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Update a pull request branch

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

resources

Resources

Link to this function

update_review(owner, repo, pull_number, review_id, body, opts \\ [])

View Source
@spec update_review(String.t(), String.t(), integer(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}

Update a review for a pull request

Updates the contents of a specified review summary comment.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources

Link to this function

update_review_comment(owner, repo, comment_id, body, opts \\ [])

View Source
@spec update_review_comment(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}

Update a review comment for a pull request

Edits the content of a specified review comment.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

resources

Resources