GitOps.GitHub (Git Ops v2.12.1)
View SourceGitHub API integration for looking up user information.
Summary
Functions
Batch find GitHub users by their email addresses. Returns a map of %{email => {:ok, user_info} | {:error, reason}}
Close the open pull request numbered number, commenting comment on it
first when one is given.
Create a GitHub release for an existing tag, returning its URL.
Find a GitHub user by their email address. Returns {:ok, user} if found, where user contains :username, :id, and :url. Returns {:error, reason} if not found or if there's an error.
The number of the open pull request for branch, or nil when there is none.
Replace the body of pull request number, returning its URL.
Create or update the open pull request for branch, returning its URL and
number.
Functions
Batch find GitHub users by their email addresses. Returns a map of %{email => {:ok, user_info} | {:error, reason}}
@spec close_pull_request(pos_integer(), String.t() | nil) :: {:ok, String.t()} | {:error, String.t()}
Close the open pull request numbered number, commenting comment on it
first when one is given.
@spec create_release(String.t(), String.t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}
Create a GitHub release for an existing tag, returning its URL.
Find a GitHub user by their email address. Returns {:ok, user} if found, where user contains :username, :id, and :url. Returns {:error, reason} if not found or if there's an error.
@spec open_pull_request_number(String.t()) :: {:ok, pos_integer() | nil} | {:error, String.t()}
The number of the open pull request for branch, or nil when there is none.
@spec update_pull_request_body(pos_integer(), String.t()) :: {:ok, String.t()} | {:error, String.t()}
Replace the body of pull request number, returning its URL.
@spec upsert_pull_request(String.t(), String.t(), String.t(), String.t(), [String.t()]) :: {:ok, %{url: String.t(), number: pos_integer()}} | {:error, String.t()}
Create or update the open pull request for branch, returning its URL and
number.
labels are applied when the pull request is first created.