defmodule GitHub.Actions do
@moduledoc """
Provides API endpoints related to actions
"""
@default_client GitHub.Client
@doc """
Add custom labels to a self-hosted runner for an organization
Add custom labels to a self-hosted runner configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization)
"""
@spec add_custom_labels_to_self_hosted_runner_for_org(String.t(), integer, map, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def add_custom_labels_to_self_hosted_runner_for_org(org, runner_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id, body: body],
call: {GitHub.Actions, :add_custom_labels_to_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}/labels",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Add custom labels to a self-hosted runner for a repository
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository)
"""
@spec add_custom_labels_to_self_hosted_runner_for_repo(
String.t(),
String.t(),
integer,
map,
keyword
) :: {:ok, map} | {:error, GitHub.Error.t()}
def add_custom_labels_to_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id, body: body],
call: {GitHub.Actions, :add_custom_labels_to_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}/labels",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Add selected repository to an organization secret
Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret)
"""
@spec add_selected_repo_to_org_secret(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def add_selected_repo_to_org_secret(org, secret_name, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name, repository_id: repository_id],
call: {GitHub.Actions, :add_selected_repo_to_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}/repositories/#{repository_id}",
method: :put,
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Add selected repository to an organization variable
Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable)
"""
@spec add_selected_repo_to_org_variable(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def add_selected_repo_to_org_variable(org, name, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name, repository_id: repository_id],
call: {GitHub.Actions, :add_selected_repo_to_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}/repositories/#{repository_id}",
method: :put,
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Approve a workflow run for a fork pull request
Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request)
"""
@spec approve_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def approve_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :approve_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/approve",
method: :post,
response: [
{201, {GitHub.EmptyObject, :t}},
{403, {GitHub.BasicError, :t}},
{404, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Cancel a workflow run
Cancels a workflow run using its `id`.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run)
"""
@spec cancel_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def cancel_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :cancel_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/cancel",
method: :post,
response: [{202, {GitHub.EmptyObject, :t}}, {409, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Create an environment variable
Create an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#create-an-environment-variable)
"""
@spec create_environment_variable(integer, String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_environment_variable(repository_id, environment_name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [repository_id: repository_id, environment_name: environment_name, body: body],
call: {GitHub.Actions, :create_environment_variable},
url: "/repositories/#{repository_id}/environments/#{environment_name}/variables",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}],
opts: opts
})
end
@doc """
Create or update an environment secret
Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret)
"""
@spec create_or_update_environment_secret(integer, String.t(), String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_or_update_environment_secret(
repository_id,
environment_name,
secret_name,
body,
opts \\ []
) do
client = opts[:client] || @default_client
client.request(%{
args: [
repository_id: repository_id,
environment_name: environment_name,
secret_name: secret_name,
body: body
],
call: {GitHub.Actions, :create_or_update_environment_secret},
url:
"/repositories/#{repository_id}/environments/#{environment_name}/secrets/#{secret_name}",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}, {204, :null}],
opts: opts
})
end
@doc """
Create or update an organization secret
Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret)
"""
@spec create_or_update_org_secret(String.t(), String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_or_update_org_secret(org, secret_name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name, body: body],
call: {GitHub.Actions, :create_or_update_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}, {204, :null}],
opts: opts
})
end
@doc """
Create or update a repository secret
Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret)
"""
@spec create_or_update_repo_secret(String.t(), String.t(), String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_or_update_repo_secret(owner, repo, secret_name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, secret_name: secret_name, body: body],
call: {GitHub.Actions, :create_or_update_repo_secret},
url: "/repos/#{owner}/#{repo}/actions/secrets/#{secret_name}",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}, {204, :null}],
opts: opts
})
end
@doc """
Create an organization variable
Creates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#create-an-organization-variable)
"""
@spec create_org_variable(String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_org_variable(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :create_org_variable},
url: "/orgs/#{org}/actions/variables",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}],
opts: opts
})
end
@doc """
Create a registration token for an organization
Returns a token that you can pass to the `config` script. The token expires after one hour.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
Example using registration token:
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.
```
./config.sh --url https://github.com/octo-org --token TOKEN
```
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization)
"""
@spec create_registration_token_for_org(String.t(), keyword) ::
{:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}
def create_registration_token_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :create_registration_token_for_org},
url: "/orgs/#{org}/actions/runners/registration-token",
method: :post,
response: [{201, {GitHub.AuthenticationToken, :t}}],
opts: opts
})
end
@doc """
Create a registration token for a repository
Returns a token that you can pass to the `config` script. The token
expires after one hour.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
Example using registration token:
Configure your self-hosted runner, replacing `TOKEN` with the registration token provided
by this endpoint.
```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository)
"""
@spec create_registration_token_for_repo(String.t(), String.t(), keyword) ::
{:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}
def create_registration_token_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :create_registration_token_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/registration-token",
method: :post,
response: [{201, {GitHub.AuthenticationToken, :t}}],
opts: opts
})
end
@doc """
Create a remove token for an organization
Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
Example using remove token:
To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this
endpoint.
```
./config.sh remove --token TOKEN
```
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization)
"""
@spec create_remove_token_for_org(String.t(), keyword) ::
{:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}
def create_remove_token_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :create_remove_token_for_org},
url: "/orgs/#{org}/actions/runners/remove-token",
method: :post,
response: [{201, {GitHub.AuthenticationToken, :t}}],
opts: opts
})
end
@doc """
Create a remove token for a repository
Returns a token that you can pass to remove a self-hosted runner from
a repository. The token expires after one hour.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
Example using remove token:
To remove your self-hosted runner from a repository, replace TOKEN with
the remove token provided by this endpoint.
```config.sh remove --token TOKEN```
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository)
"""
@spec create_remove_token_for_repo(String.t(), String.t(), keyword) ::
{:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}
def create_remove_token_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :create_remove_token_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/remove-token",
method: :post,
response: [{201, {GitHub.AuthenticationToken, :t}}],
opts: opts
})
end
@doc """
Create a repository variable
Creates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#create-a-repository-variable)
"""
@spec create_repo_variable(String.t(), String.t(), map, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def create_repo_variable(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :create_repo_variable},
url: "/repos/#{owner}/#{repo}/actions/variables",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [{201, {GitHub.EmptyObject, :t}}],
opts: opts
})
end
@doc """
Create a workflow dispatch event
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](https://docs.github.com/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event)
"""
@spec create_workflow_dispatch(String.t(), String.t(), integer | String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def create_workflow_dispatch(owner, repo, workflow_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id, body: body],
call: {GitHub.Actions, :create_workflow_dispatch},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}/dispatches",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a GitHub Actions cache for a repository (using a cache ID)
Deletes a GitHub Actions cache for a repository, using a cache ID.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id)
"""
@spec delete_actions_cache_by_id(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_actions_cache_by_id(owner, repo, cache_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, cache_id: cache_id],
call: {GitHub.Actions, :delete_actions_cache_by_id},
url: "/repos/#{owner}/#{repo}/actions/caches/#{cache_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete GitHub Actions caches for a repository (using a cache key)
Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:write` permission to use this endpoint.
## Options
* `key`: A key for identifying the cache.
* `ref`: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key)
"""
@spec delete_actions_cache_by_key(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}
def delete_actions_cache_by_key(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:key, :ref])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :delete_actions_cache_by_key},
url: "/repos/#{owner}/#{repo}/actions/caches",
method: :delete,
query: query,
response: [{200, {GitHub.Actions.CacheList, :t}}],
opts: opts
})
end
@doc """
Delete an artifact
Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/artifacts#delete-an-artifact)
"""
@spec delete_artifact(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_artifact(owner, repo, artifact_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, artifact_id: artifact_id],
call: {GitHub.Actions, :delete_artifact},
url: "/repos/#{owner}/#{repo}/actions/artifacts/#{artifact_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete an environment secret
Deletes a secret in an environment using the secret name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#delete-an-environment-secret)
"""
@spec delete_environment_secret(integer, String.t(), String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_environment_secret(repository_id, environment_name, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [
repository_id: repository_id,
environment_name: environment_name,
secret_name: secret_name
],
call: {GitHub.Actions, :delete_environment_secret},
url:
"/repositories/#{repository_id}/environments/#{environment_name}/secrets/#{secret_name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete an environment variable
Deletes an environment variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#delete-an-environment-variable)
"""
@spec delete_environment_variable(integer, String.t(), String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_environment_variable(repository_id, name, environment_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [repository_id: repository_id, name: name, environment_name: environment_name],
call: {GitHub.Actions, :delete_environment_variable},
url: "/repositories/#{repository_id}/environments/#{environment_name}/variables/#{name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete an organization secret
Deletes a secret in an organization using the secret name.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#delete-an-organization-secret)
"""
@spec delete_org_secret(String.t(), String.t(), keyword) :: :ok | {:error, GitHub.Error.t()}
def delete_org_secret(org, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name],
call: {GitHub.Actions, :delete_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete an organization variable
Deletes an organization variable using the variable name.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#delete-an-organization-variable)
"""
@spec delete_org_variable(String.t(), String.t(), keyword) :: :ok | {:error, GitHub.Error.t()}
def delete_org_variable(org, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name],
call: {GitHub.Actions, :delete_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a repository secret
Deletes a secret in a repository using the secret name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#delete-a-repository-secret)
"""
@spec delete_repo_secret(String.t(), String.t(), String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_repo_secret(owner, repo, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, secret_name: secret_name],
call: {GitHub.Actions, :delete_repo_secret},
url: "/repos/#{owner}/#{repo}/actions/secrets/#{secret_name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a repository variable
Deletes a repository variable using the variable name.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#delete-a-repository-variable)
"""
@spec delete_repo_variable(String.t(), String.t(), String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_repo_variable(owner, repo, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, name: name],
call: {GitHub.Actions, :delete_repo_variable},
url: "/repos/#{owner}/#{repo}/actions/variables/#{name}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a self-hosted runner from an organization
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization)
"""
@spec delete_self_hosted_runner_from_org(String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_self_hosted_runner_from_org(org, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id],
call: {GitHub.Actions, :delete_self_hosted_runner_from_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a self-hosted runner from a repository
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository)
"""
@spec delete_self_hosted_runner_from_repo(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_self_hosted_runner_from_repo(owner, repo, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id],
call: {GitHub.Actions, :delete_self_hosted_runner_from_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete a workflow run
Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run)
"""
@spec delete_workflow_run(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :delete_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Delete workflow run logs
Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs)
"""
@spec delete_workflow_run_logs(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def delete_workflow_run_logs(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :delete_workflow_run_logs},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/logs",
method: :delete,
response: [{204, :null}, {403, {GitHub.BasicError, :t}}, {500, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Disable a selected repository for GitHub Actions in an organization
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization)
"""
@spec disable_selected_repository_github_actions_organization(String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def disable_selected_repository_github_actions_organization(org, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, repository_id: repository_id],
call: {GitHub.Actions, :disable_selected_repository_github_actions_organization},
url: "/orgs/#{org}/actions/permissions/repositories/#{repository_id}",
method: :delete,
response: [{204, :null}],
opts: opts
})
end
@doc """
Disable a workflow
Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#disable-a-workflow)
"""
@spec disable_workflow(String.t(), String.t(), integer | String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def disable_workflow(owner, repo, workflow_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id],
call: {GitHub.Actions, :disable_workflow},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}/disable",
method: :put,
response: [{204, :null}],
opts: opts
})
end
@doc """
Download an artifact
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
the response header to find the URL for the download. The `:archive_format` must be `zip`.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/artifacts#download-an-artifact)
"""
@spec download_artifact(String.t(), String.t(), integer, String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def download_artifact(owner, repo, artifact_id, archive_format, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, artifact_id: artifact_id, archive_format: archive_format],
call: {GitHub.Actions, :download_artifact},
url: "/repos/#{owner}/#{repo}/actions/artifacts/#{artifact_id}/#{archive_format}",
method: :get,
response: [{302, :null}, {410, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Download job logs for a workflow run
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run)
"""
@spec download_job_logs_for_workflow_run(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def download_job_logs_for_workflow_run(owner, repo, job_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, job_id: job_id],
call: {GitHub.Actions, :download_job_logs_for_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/jobs/#{job_id}/logs",
method: :get,
response: [{302, :null}],
opts: opts
})
end
@doc """
Download workflow run attempt logs
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs)
"""
@spec download_workflow_run_attempt_logs(String.t(), String.t(), integer, integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def download_workflow_run_attempt_logs(owner, repo, run_id, attempt_number, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, attempt_number: attempt_number],
call: {GitHub.Actions, :download_workflow_run_attempt_logs},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/logs",
method: :get,
response: [{302, :null}],
opts: opts
})
end
@doc """
Download workflow run logs
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs)
"""
@spec download_workflow_run_logs(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def download_workflow_run_logs(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :download_workflow_run_logs},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/logs",
method: :get,
response: [{302, :null}],
opts: opts
})
end
@doc """
Enable a selected repository for GitHub Actions in an organization
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization)
"""
@spec enable_selected_repository_github_actions_organization(String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def enable_selected_repository_github_actions_organization(org, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, repository_id: repository_id],
call: {GitHub.Actions, :enable_selected_repository_github_actions_organization},
url: "/orgs/#{org}/actions/permissions/repositories/#{repository_id}",
method: :put,
response: [{204, :null}],
opts: opts
})
end
@doc """
Enable a workflow
Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#enable-a-workflow)
"""
@spec enable_workflow(String.t(), String.t(), integer | String.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def enable_workflow(owner, repo, workflow_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id],
call: {GitHub.Actions, :enable_workflow},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}/enable",
method: :put,
response: [{204, :null}],
opts: opts
})
end
@doc """
Force cancel a workflow run
Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run).
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run)
"""
@spec force_cancel_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def force_cancel_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :force_cancel_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/force-cancel",
method: :post,
response: [{202, {GitHub.EmptyObject, :t}}, {409, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Create configuration for a just-in-time runner for an organization
Generates a configuration that can be passed to the runner application at startup.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization)
"""
@spec generate_runner_jitconfig_for_org(String.t(), map, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def generate_runner_jitconfig_for_org(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :generate_runner_jitconfig_for_org},
url: "/orgs/#{org}/actions/runners/generate-jitconfig",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{201, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Create configuration for a just-in-time runner for a repository
Generates a configuration that can be passed to the runner application at startup.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository)
"""
@spec generate_runner_jitconfig_for_repo(String.t(), String.t(), map, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def generate_runner_jitconfig_for_repo(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :generate_runner_jitconfig_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/generate-jitconfig",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [
{201, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
List GitHub Actions caches for a repository
Lists the GitHub Actions caches for a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
* `ref`: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.
* `key`: An explicit key or prefix for identifying the cache
* `sort`: The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.
* `direction`: The direction to sort the results by.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository)
"""
@spec get_actions_cache_list(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}
def get_actions_cache_list(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:direction, :key, :page, :per_page, :ref, :sort])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_actions_cache_list},
url: "/repos/#{owner}/#{repo}/actions/caches",
method: :get,
query: query,
response: [{200, {GitHub.Actions.CacheList, :t}}],
opts: opts
})
end
@doc """
Get GitHub Actions cache usage for a repository
Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository)
"""
@spec get_actions_cache_usage(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.CacheUsageByRepository.t()} | {:error, GitHub.Error.t()}
def get_actions_cache_usage(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_actions_cache_usage},
url: "/repos/#{owner}/#{repo}/actions/cache/usage",
method: :get,
response: [{200, {GitHub.Actions.CacheUsageByRepository, :t}}],
opts: opts
})
end
@doc """
List repositories with GitHub Actions cache usage for an organization
Lists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization)
"""
@spec get_actions_cache_usage_by_repo_for_org(String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def get_actions_cache_usage_by_repo_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_actions_cache_usage_by_repo_for_org},
url: "/orgs/#{org}/actions/cache/usage-by-repository",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
Get GitHub Actions cache usage for an organization
Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization)
"""
@spec get_actions_cache_usage_for_org(String.t(), keyword) ::
{:ok, GitHub.Actions.CacheUsageOrgEnterprise.t()} | {:error, GitHub.Error.t()}
def get_actions_cache_usage_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_actions_cache_usage_for_org},
url: "/orgs/#{org}/actions/cache/usage",
method: :get,
response: [{200, {GitHub.Actions.CacheUsageOrgEnterprise, :t}}],
opts: opts
})
end
@doc """
Get allowed actions and reusable workflows for an organization
Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization)
"""
@spec get_allowed_actions_organization(String.t(), keyword) ::
{:ok, GitHub.SelectedActions.t()} | {:error, GitHub.Error.t()}
def get_allowed_actions_organization(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_allowed_actions_organization},
url: "/orgs/#{org}/actions/permissions/selected-actions",
method: :get,
response: [{200, {GitHub.SelectedActions, :t}}],
opts: opts
})
end
@doc """
Get allowed actions and reusable workflows for a repository
Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository)
"""
@spec get_allowed_actions_repository(String.t(), String.t(), keyword) ::
{:ok, GitHub.SelectedActions.t()} | {:error, GitHub.Error.t()}
def get_allowed_actions_repository(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_allowed_actions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/selected-actions",
method: :get,
response: [{200, {GitHub.SelectedActions, :t}}],
opts: opts
})
end
@doc """
Get an artifact
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/artifacts#get-an-artifact)
"""
@spec get_artifact(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.Artifact.t()} | {:error, GitHub.Error.t()}
def get_artifact(owner, repo, artifact_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, artifact_id: artifact_id],
call: {GitHub.Actions, :get_artifact},
url: "/repos/#{owner}/#{repo}/actions/artifacts/#{artifact_id}",
method: :get,
response: [{200, {GitHub.Artifact, :t}}],
opts: opts
})
end
@doc """
Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository)
"""
@spec get_custom_oidc_sub_claim_for_repo(String.t(), String.t(), keyword) ::
{:ok, GitHub.OIDCCustomSubRepo.t()} | {:error, GitHub.Error.t()}
def get_custom_oidc_sub_claim_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_custom_oidc_sub_claim_for_repo},
url: "/repos/#{owner}/#{repo}/actions/oidc/customization/sub",
method: :get,
response: [
{200, {GitHub.OIDCCustomSubRepo, :t}},
{400, {:union, [{GitHub.BasicError, :t}, {GitHub.SCIM.Error, :t}]}},
{404, {GitHub.BasicError, :t}}
],
opts: opts
})
end
@doc """
Get an environment public key
Get the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.
Anyone with read access to the repository can use this endpoint.
If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key)
"""
@spec get_environment_public_key(integer, String.t(), keyword) ::
{:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}
def get_environment_public_key(repository_id, environment_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [repository_id: repository_id, environment_name: environment_name],
call: {GitHub.Actions, :get_environment_public_key},
url: "/repositories/#{repository_id}/environments/#{environment_name}/secrets/public-key",
method: :get,
response: [{200, {GitHub.Actions.PublicKey, :t}}],
opts: opts
})
end
@doc """
Get an environment secret
Gets a single environment secret without revealing its encrypted value.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-an-environment-secret)
"""
@spec get_environment_secret(integer, String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.Secret.t()} | {:error, GitHub.Error.t()}
def get_environment_secret(repository_id, environment_name, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [
repository_id: repository_id,
environment_name: environment_name,
secret_name: secret_name
],
call: {GitHub.Actions, :get_environment_secret},
url:
"/repositories/#{repository_id}/environments/#{environment_name}/secrets/#{secret_name}",
method: :get,
response: [{200, {GitHub.Actions.Secret, :t}}],
opts: opts
})
end
@doc """
Get an environment variable
Gets a specific variable in an environment.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#get-an-environment-variable)
"""
@spec get_environment_variable(integer, String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.Variable.t()} | {:error, GitHub.Error.t()}
def get_environment_variable(repository_id, environment_name, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [repository_id: repository_id, environment_name: environment_name, name: name],
call: {GitHub.Actions, :get_environment_variable},
url: "/repositories/#{repository_id}/environments/#{environment_name}/variables/#{name}",
method: :get,
response: [{200, {GitHub.Actions.Variable, :t}}],
opts: opts
})
end
@doc """
Get default workflow permissions for an organization
Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization)
"""
@spec get_github_actions_default_workflow_permissions_organization(String.t(), keyword) ::
{:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()} | {:error, GitHub.Error.t()}
def get_github_actions_default_workflow_permissions_organization(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_github_actions_default_workflow_permissions_organization},
url: "/orgs/#{org}/actions/permissions/workflow",
method: :get,
response: [{200, {GitHub.Actions.GetDefaultWorkflowPermissions, :t}}],
opts: opts
})
end
@doc """
Get default workflow permissions for a repository
Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository)
"""
@spec get_github_actions_default_workflow_permissions_repository(
String.t(),
String.t(),
keyword
) :: {:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()} | {:error, GitHub.Error.t()}
def get_github_actions_default_workflow_permissions_repository(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_github_actions_default_workflow_permissions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/workflow",
method: :get,
response: [{200, {GitHub.Actions.GetDefaultWorkflowPermissions, :t}}],
opts: opts
})
end
@doc """
Get GitHub Actions permissions for an organization
Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization)
"""
@spec get_github_actions_permissions_organization(String.t(), keyword) ::
{:ok, GitHub.Actions.OrganizationPermissions.t()} | {:error, GitHub.Error.t()}
def get_github_actions_permissions_organization(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_github_actions_permissions_organization},
url: "/orgs/#{org}/actions/permissions",
method: :get,
response: [{200, {GitHub.Actions.OrganizationPermissions, :t}}],
opts: opts
})
end
@doc """
Get GitHub Actions permissions for a repository
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository)
"""
@spec get_github_actions_permissions_repository(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.RepositoryPermissions.t()} | {:error, GitHub.Error.t()}
def get_github_actions_permissions_repository(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_github_actions_permissions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions",
method: :get,
response: [{200, {GitHub.Actions.RepositoryPermissions, :t}}],
opts: opts
})
end
@doc """
Get a job for a workflow run
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run)
"""
@spec get_job_for_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.Actions.Job.t()} | {:error, GitHub.Error.t()}
def get_job_for_workflow_run(owner, repo, job_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, job_id: job_id],
call: {GitHub.Actions, :get_job_for_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/jobs/#{job_id}",
method: :get,
response: [{200, {GitHub.Actions.Job, :t}}],
opts: opts
})
end
@doc """
Get an organization public key
Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key)
"""
@spec get_org_public_key(String.t(), keyword) ::
{:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}
def get_org_public_key(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :get_org_public_key},
url: "/orgs/#{org}/actions/secrets/public-key",
method: :get,
response: [{200, {GitHub.Actions.PublicKey, :t}}],
opts: opts
})
end
@doc """
Get an organization secret
Gets a single organization secret without revealing its encrypted value.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-an-organization-secret)
"""
@spec get_org_secret(String.t(), String.t(), keyword) ::
{:ok, GitHub.Organization.ActionsSecret.t()} | {:error, GitHub.Error.t()}
def get_org_secret(org, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name],
call: {GitHub.Actions, :get_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}",
method: :get,
response: [{200, {GitHub.Organization.ActionsSecret, :t}}],
opts: opts
})
end
@doc """
Get an organization variable
Gets a specific variable in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#get-an-organization-variable)
"""
@spec get_org_variable(String.t(), String.t(), keyword) ::
{:ok, GitHub.Organization.ActionsVariable.t()} | {:error, GitHub.Error.t()}
def get_org_variable(org, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name],
call: {GitHub.Actions, :get_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}",
method: :get,
response: [{200, {GitHub.Organization.ActionsVariable, :t}}],
opts: opts
})
end
@doc """
Get pending deployments for a workflow run
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run)
"""
@spec get_pending_deployments_for_run(String.t(), String.t(), integer, keyword) ::
{:ok, [GitHub.PendingDeployment.t()]} | {:error, GitHub.Error.t()}
def get_pending_deployments_for_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :get_pending_deployments_for_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/pending_deployments",
method: :get,
response: [{200, [{GitHub.PendingDeployment, :t}]}],
opts: opts
})
end
@doc """
Get a repository public key
Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.
Anyone with read access to the repository can use this endpoint.
If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key)
"""
@spec get_repo_public_key(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}
def get_repo_public_key(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_repo_public_key},
url: "/repos/#{owner}/#{repo}/actions/secrets/public-key",
method: :get,
response: [{200, {GitHub.Actions.PublicKey, :t}}],
opts: opts
})
end
@doc """
Get a repository secret
Gets a single repository secret without revealing its encrypted value.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#get-a-repository-secret)
"""
@spec get_repo_secret(String.t(), String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.Secret.t()} | {:error, GitHub.Error.t()}
def get_repo_secret(owner, repo, secret_name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, secret_name: secret_name],
call: {GitHub.Actions, :get_repo_secret},
url: "/repos/#{owner}/#{repo}/actions/secrets/#{secret_name}",
method: :get,
response: [{200, {GitHub.Actions.Secret, :t}}],
opts: opts
})
end
@doc """
Get a repository variable
Gets a specific variable in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#get-a-repository-variable)
"""
@spec get_repo_variable(String.t(), String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.Variable.t()} | {:error, GitHub.Error.t()}
def get_repo_variable(owner, repo, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, name: name],
call: {GitHub.Actions, :get_repo_variable},
url: "/repos/#{owner}/#{repo}/actions/variables/#{name}",
method: :get,
response: [{200, {GitHub.Actions.Variable, :t}}],
opts: opts
})
end
@doc """
Get the review history for a workflow run
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run)
"""
@spec get_reviews_for_run(String.t(), String.t(), integer, keyword) ::
{:ok, [GitHub.EnvironmentApprovals.t()]} | {:error, GitHub.Error.t()}
def get_reviews_for_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :get_reviews_for_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/approvals",
method: :get,
response: [{200, [{GitHub.EnvironmentApprovals, :t}]}],
opts: opts
})
end
@doc """
Get a self-hosted runner for an organization
Gets a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization)
"""
@spec get_self_hosted_runner_for_org(String.t(), integer, keyword) ::
{:ok, GitHub.Actions.Runner.t()} | {:error, GitHub.Error.t()}
def get_self_hosted_runner_for_org(org, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id],
call: {GitHub.Actions, :get_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}",
method: :get,
response: [{200, {GitHub.Actions.Runner, :t}}],
opts: opts
})
end
@doc """
Get a self-hosted runner for a repository
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository)
"""
@spec get_self_hosted_runner_for_repo(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.Actions.Runner.t()} | {:error, GitHub.Error.t()}
def get_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id],
call: {GitHub.Actions, :get_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}",
method: :get,
response: [{200, {GitHub.Actions.Runner, :t}}],
opts: opts
})
end
@doc """
Get a workflow
Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#get-a-workflow)
"""
@spec get_workflow(String.t(), String.t(), integer | String.t(), keyword) ::
{:ok, GitHub.Actions.Workflow.t()} | {:error, GitHub.Error.t()}
def get_workflow(owner, repo, workflow_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id],
call: {GitHub.Actions, :get_workflow},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}",
method: :get,
response: [{200, {GitHub.Actions.Workflow, :t}}],
opts: opts
})
end
@doc """
Get the level of access for workflows outside of the repository
Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
repository `administration` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository)
"""
@spec get_workflow_access_to_repository(String.t(), String.t(), keyword) ::
{:ok, GitHub.Actions.Workflow.AccessToRepository.t()} | {:error, GitHub.Error.t()}
def get_workflow_access_to_repository(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :get_workflow_access_to_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/access",
method: :get,
response: [{200, {GitHub.Actions.Workflow.AccessToRepository, :t}}],
opts: opts
})
end
@doc """
Get a workflow run
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `exclude_pull_requests`: If `true` pull requests are omitted from the response (empty array).
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run)
"""
@spec get_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.Actions.Workflow.Run.t()} | {:error, GitHub.Error.t()}
def get_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:exclude_pull_requests])
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :get_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}",
method: :get,
query: query,
response: [{200, {GitHub.Actions.Workflow.Run, :t}}],
opts: opts
})
end
@doc """
Get a workflow run attempt
Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the `repo` scope. GitHub Apps must have the `actions:read` permission to
use this endpoint.
## Options
* `exclude_pull_requests`: If `true` pull requests are omitted from the response (empty array).
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt)
"""
@spec get_workflow_run_attempt(String.t(), String.t(), integer, integer, keyword) ::
{:ok, GitHub.Actions.Workflow.Run.t()} | {:error, GitHub.Error.t()}
def get_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:exclude_pull_requests])
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, attempt_number: attempt_number],
call: {GitHub.Actions, :get_workflow_run_attempt},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/attempts/#{attempt_number}",
method: :get,
query: query,
response: [{200, {GitHub.Actions.Workflow.Run, :t}}],
opts: opts
})
end
@doc """
Get workflow run usage
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage)
"""
@spec get_workflow_run_usage(String.t(), String.t(), integer, keyword) ::
{:ok, GitHub.Actions.Workflow.RunUsage.t()} | {:error, GitHub.Error.t()}
def get_workflow_run_usage(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :get_workflow_run_usage},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/timing",
method: :get,
response: [{200, {GitHub.Actions.Workflow.RunUsage, :t}}],
opts: opts
})
end
@doc """
Get workflow usage
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".
You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#get-workflow-usage)
"""
@spec get_workflow_usage(String.t(), String.t(), integer | String.t(), keyword) ::
{:ok, GitHub.Actions.Workflow.Usage.t()} | {:error, GitHub.Error.t()}
def get_workflow_usage(owner, repo, workflow_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id],
call: {GitHub.Actions, :get_workflow_usage},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}/timing",
method: :get,
response: [{200, {GitHub.Actions.Workflow.Usage, :t}}],
opts: opts
})
end
@doc """
List artifacts for a repository
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
* `name`: The name field of an artifact. When specified, only artifacts with this name will be returned.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository)
"""
@spec list_artifacts_for_repo(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_artifacts_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:name, :page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_artifacts_for_repo},
url: "/repos/#{owner}/#{repo}/actions/artifacts",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List environment secrets
Lists all secrets available in an environment without revealing their
encrypted values.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#list-environment-secrets)
"""
@spec list_environment_secrets(integer, String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_environment_secrets(repository_id, environment_name, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [repository_id: repository_id, environment_name: environment_name],
call: {GitHub.Actions, :list_environment_secrets},
url: "/repositories/#{repository_id}/environments/#{environment_name}/secrets",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List environment variables
Lists all environment variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Options
* `per_page`: The number of results per page (max 30).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#list-environment-variables)
"""
@spec list_environment_variables(integer, String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_environment_variables(repository_id, environment_name, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [repository_id: repository_id, environment_name: environment_name],
call: {GitHub.Actions, :list_environment_variables},
url: "/repositories/#{repository_id}/environments/#{environment_name}/variables",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List jobs for a workflow run
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
## Options
* `filter`: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run)
"""
@spec list_jobs_for_workflow_run(String.t(), String.t(), integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_jobs_for_workflow_run(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:filter, :page, :per_page])
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :list_jobs_for_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/jobs",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List jobs for a workflow run attempt
Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt)
"""
@spec list_jobs_for_workflow_run_attempt(String.t(), String.t(), integer, integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_jobs_for_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, attempt_number: attempt_number],
call: {GitHub.Actions, :list_jobs_for_workflow_run_attempt},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/attempts/#{attempt_number}/jobs",
method: :get,
query: query,
response: [{200, :map}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
List labels for a self-hosted runner for an organization
Lists all labels for a self-hosted runner configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization)
"""
@spec list_labels_for_self_hosted_runner_for_org(String.t(), integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_labels_for_self_hosted_runner_for_org(org, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id],
call: {GitHub.Actions, :list_labels_for_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}/labels",
method: :get,
response: [{200, :map}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
List labels for a self-hosted runner for a repository
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository)
"""
@spec list_labels_for_self_hosted_runner_for_repo(String.t(), String.t(), integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id],
call: {GitHub.Actions, :list_labels_for_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}/labels",
method: :get,
response: [{200, :map}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
List organization secrets
Lists all secrets available in an organization without revealing their
encrypted values.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#list-organization-secrets)
"""
@spec list_org_secrets(String.t(), keyword) :: {:ok, map} | {:error, GitHub.Error.t()}
def list_org_secrets(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Actions, :list_org_secrets},
url: "/orgs/#{org}/actions/secrets",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List organization variables
Lists all organization variables.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Options
* `per_page`: The number of results per page (max 30).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#list-organization-variables)
"""
@spec list_org_variables(String.t(), keyword) :: {:ok, map} | {:error, GitHub.Error.t()}
def list_org_variables(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Actions, :list_org_variables},
url: "/orgs/#{org}/actions/variables",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List repository organization secrets
Lists all organization secrets shared with a repository without revealing their encrypted
values.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets)
"""
@spec list_repo_organization_secrets(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_repo_organization_secrets(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_repo_organization_secrets},
url: "/repos/#{owner}/#{repo}/actions/organization-secrets",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List repository organization variables
Lists all organiation variables shared with a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Options
* `per_page`: The number of results per page (max 30).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#list-repository-organization-variables)
"""
@spec list_repo_organization_variables(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_repo_organization_variables(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_repo_organization_variables},
url: "/repos/#{owner}/#{repo}/actions/organization-variables",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List repository secrets
Lists all secrets available in a repository without revealing their encrypted
values.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#list-repository-secrets)
"""
@spec list_repo_secrets(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_repo_secrets(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_repo_secrets},
url: "/repos/#{owner}/#{repo}/actions/secrets",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List repository variables
Lists all repository variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Options
* `per_page`: The number of results per page (max 30).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#list-repository-variables)
"""
@spec list_repo_variables(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_repo_variables(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_repo_variables},
url: "/repos/#{owner}/#{repo}/actions/variables",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List repository workflows
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflows#list-repository-workflows)
"""
@spec list_repo_workflows(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_repo_workflows(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_repo_workflows},
url: "/repos/#{owner}/#{repo}/actions/workflows",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List runner applications for an organization
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization)
"""
@spec list_runner_applications_for_org(String.t(), keyword) ::
{:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}
def list_runner_applications_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org],
call: {GitHub.Actions, :list_runner_applications_for_org},
url: "/orgs/#{org}/actions/runners/downloads",
method: :get,
response: [{200, [{GitHub.Actions.Runner.Application, :t}]}],
opts: opts
})
end
@doc """
List runner applications for a repository
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository)
"""
@spec list_runner_applications_for_repo(String.t(), String.t(), keyword) ::
{:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}
def list_runner_applications_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_runner_applications_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/downloads",
method: :get,
response: [{200, [{GitHub.Actions.Runner.Application, :t}]}],
opts: opts
})
end
@doc """
List selected repositories for an organization secret
Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Options
* `page`: Page number of the results to fetch.
* `per_page`: The number of results per page (max 100).
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret)
"""
@spec list_selected_repos_for_org_secret(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_selected_repos_for_org_secret(org, secret_name, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org, secret_name: secret_name],
call: {GitHub.Actions, :list_selected_repos_for_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}/repositories",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List selected repositories for an organization variable
Lists all repositories that can access an organization variable
that is available to selected repositories.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Options
* `page`: Page number of the results to fetch.
* `per_page`: The number of results per page (max 100).
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable)
"""
@spec list_selected_repos_for_org_variable(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_selected_repos_for_org_variable(org, name, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org, name: name],
call: {GitHub.Actions, :list_selected_repos_for_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}/repositories",
method: :get,
query: query,
response: [{200, :map}, {409, :null}],
opts: opts
})
end
@doc """
List selected repositories enabled for GitHub Actions in an organization
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization)
"""
@spec list_selected_repositories_enabled_github_actions_organization(String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_selected_repositories_enabled_github_actions_organization(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Actions, :list_selected_repositories_enabled_github_actions_organization},
url: "/orgs/#{org}/actions/permissions/repositories",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List self-hosted runners for an organization
Lists all self-hosted runners configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Options
* `name`: The name of a self-hosted runner.
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization)
"""
@spec list_self_hosted_runners_for_org(String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_self_hosted_runners_for_org(org, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:name, :page, :per_page])
client.request(%{
args: [org: org],
call: {GitHub.Actions, :list_self_hosted_runners_for_org},
url: "/orgs/#{org}/actions/runners",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List self-hosted runners for a repository
Lists all self-hosted runners configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Options
* `name`: The name of a self-hosted runner.
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository)
"""
@spec list_self_hosted_runners_for_repo(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_self_hosted_runners_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:name, :page, :per_page])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_self_hosted_runners_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List workflow run artifacts
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
* `name`: The name field of an artifact. When specified, only artifacts with this name will be returned.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts)
"""
@spec list_workflow_run_artifacts(String.t(), String.t(), integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_workflow_run_artifacts(owner, repo, run_id, opts \\ []) do
client = opts[:client] || @default_client
query = Keyword.take(opts, [:name, :page, :per_page])
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id],
call: {GitHub.Actions, :list_workflow_run_artifacts},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/artifacts",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List workflow runs for a workflow
List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
## Options
* `actor`: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
* `branch`: Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
* `event`: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."
* `status`: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
* `created`: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
* `exclude_pull_requests`: If `true` pull requests are omitted from the response (empty array).
* `check_suite_id`: Returns workflow runs with the `check_suite_id` that you specify.
* `head_sha`: Only returns workflow runs that are associated with the specified `head_sha`.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow)
"""
@spec list_workflow_runs(String.t(), String.t(), integer | String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_workflow_runs(owner, repo, workflow_id, opts \\ []) do
client = opts[:client] || @default_client
query =
Keyword.take(opts, [
:actor,
:branch,
:check_suite_id,
:created,
:event,
:exclude_pull_requests,
:head_sha,
:page,
:per_page,
:status
])
client.request(%{
args: [owner: owner, repo: repo, workflow_id: workflow_id],
call: {GitHub.Actions, :list_workflow_runs},
url: "/repos/#{owner}/#{repo}/actions/workflows/#{workflow_id}/runs",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
List workflow runs for a repository
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
## Options
* `actor`: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
* `branch`: Returns workflow runs associated with a branch. Use the name of the branch of the `push`.
* `event`: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."
* `status`: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.
* `per_page`: The number of results per page (max 100).
* `page`: Page number of the results to fetch.
* `created`: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
* `exclude_pull_requests`: If `true` pull requests are omitted from the response (empty array).
* `check_suite_id`: Returns workflow runs with the `check_suite_id` that you specify.
* `head_sha`: Only returns workflow runs that are associated with the specified `head_sha`.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository)
"""
@spec list_workflow_runs_for_repo(String.t(), String.t(), keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def list_workflow_runs_for_repo(owner, repo, opts \\ []) do
client = opts[:client] || @default_client
query =
Keyword.take(opts, [
:actor,
:branch,
:check_suite_id,
:created,
:event,
:exclude_pull_requests,
:head_sha,
:page,
:per_page,
:status
])
client.request(%{
args: [owner: owner, repo: repo],
call: {GitHub.Actions, :list_workflow_runs_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runs",
method: :get,
query: query,
response: [{200, :map}],
opts: opts
})
end
@doc """
Re-run a job from a workflow run
Re-run a job and its dependent jobs in a workflow run.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)
"""
@spec re_run_job_for_workflow_run(String.t(), String.t(), integer, map | nil, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def re_run_job_for_workflow_run(owner, repo, job_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, job_id: job_id, body: body],
call: {GitHub.Actions, :re_run_job_for_workflow_run},
url: "/repos/#{owner}/#{repo}/actions/jobs/#{job_id}/rerun",
body: body,
method: :post,
request: [{"application/json", {:union, [:map, :null]}}],
response: [{201, {GitHub.EmptyObject, :t}}, {403, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Re-run a workflow
Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow)
"""
@spec re_run_workflow(String.t(), String.t(), integer, map | nil, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def re_run_workflow(owner, repo, run_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, body: body],
call: {GitHub.Actions, :re_run_workflow},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/rerun",
body: body,
method: :post,
request: [{"application/json", {:union, [:map, :null]}}],
response: [{201, {GitHub.EmptyObject, :t}}],
opts: opts
})
end
@doc """
Re-run failed jobs from a workflow run
Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run)
"""
@spec re_run_workflow_failed_jobs(String.t(), String.t(), integer, map | nil, keyword) ::
{:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def re_run_workflow_failed_jobs(owner, repo, run_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, body: body],
call: {GitHub.Actions, :re_run_workflow_failed_jobs},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/rerun-failed-jobs",
body: body,
method: :post,
request: [{"application/json", {:union, [:map, :null]}}],
response: [{201, {GitHub.EmptyObject, :t}}],
opts: opts
})
end
@doc """
Remove all custom labels from a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization)
"""
@spec remove_all_custom_labels_from_self_hosted_runner_for_org(String.t(), integer, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def remove_all_custom_labels_from_self_hosted_runner_for_org(org, runner_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id],
call: {GitHub.Actions, :remove_all_custom_labels_from_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}/labels",
method: :delete,
response: [{200, :map}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Remove all custom labels from a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository)
"""
@spec remove_all_custom_labels_from_self_hosted_runner_for_repo(
String.t(),
String.t(),
integer,
keyword
) :: {:ok, map} | {:error, GitHub.Error.t()}
def remove_all_custom_labels_from_self_hosted_runner_for_repo(
owner,
repo,
runner_id,
opts \\ []
) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id],
call: {GitHub.Actions, :remove_all_custom_labels_from_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}/labels",
method: :delete,
response: [{200, :map}, {404, {GitHub.BasicError, :t}}],
opts: opts
})
end
@doc """
Remove a custom label from a self-hosted runner for an organization
Remove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.
This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization)
"""
@spec remove_custom_label_from_self_hosted_runner_for_org(
String.t(),
integer,
String.t(),
keyword
) :: {:ok, map} | {:error, GitHub.Error.t()}
def remove_custom_label_from_self_hosted_runner_for_org(org, runner_id, name, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id, name: name],
call: {GitHub.Actions, :remove_custom_label_from_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}/labels/#{name}",
method: :delete,
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Remove a custom label from a self-hosted runner for a repository
Remove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.
This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository)
"""
@spec remove_custom_label_from_self_hosted_runner_for_repo(
String.t(),
String.t(),
integer,
String.t(),
keyword
) :: {:ok, map} | {:error, GitHub.Error.t()}
def remove_custom_label_from_self_hosted_runner_for_repo(
owner,
repo,
runner_id,
name,
opts \\ []
) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id, name: name],
call: {GitHub.Actions, :remove_custom_label_from_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}/labels/#{name}",
method: :delete,
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Remove selected repository from an organization secret
Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret)
"""
@spec remove_selected_repo_from_org_secret(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def remove_selected_repo_from_org_secret(org, secret_name, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name, repository_id: repository_id],
call: {GitHub.Actions, :remove_selected_repo_from_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}/repositories/#{repository_id}",
method: :delete,
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Remove selected repository from an organization variable
Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their `visibility` field set to `selected`.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable)
"""
@spec remove_selected_repo_from_org_variable(String.t(), String.t(), integer, keyword) ::
:ok | {:error, GitHub.Error.t()}
def remove_selected_repo_from_org_variable(org, name, repository_id, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name, repository_id: repository_id],
call: {GitHub.Actions, :remove_selected_repo_from_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}/repositories/#{repository_id}",
method: :delete,
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Review custom deployment protection rules for a workflow run
Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
**Note:** GitHub Apps can only review their own custom deployment protection rules.
To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have read and write permission for **Deployments** to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run)
"""
@spec review_custom_gates_for_run(
String.t(),
String.t(),
integer,
GitHub.Actions.ReviewCustomGates.CommentRequired.t()
| GitHub.Actions.ReviewCustomGates.StateRequired.t(),
keyword
) :: :ok | {:error, GitHub.Error.t()}
def review_custom_gates_for_run(owner, repo, run_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, body: body],
call: {GitHub.Actions, :review_custom_gates_for_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/deployment_protection_rule",
body: body,
method: :post,
request: [
{"application/json",
{:union,
[
{GitHub.Actions.ReviewCustomGates.CommentRequired, :t},
{GitHub.Actions.ReviewCustomGates.StateRequired, :t}
]}}
],
response: [{204, :null}],
opts: opts
})
end
@doc """
Review pending deployments for a workflow run
Approve or reject pending deployments that are waiting on approval by a required reviewer.
Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run)
"""
@spec review_pending_deployments_for_run(String.t(), String.t(), integer, map, keyword) ::
{:ok, [GitHub.Deployment.t()]} | {:error, GitHub.Error.t()}
def review_pending_deployments_for_run(owner, repo, run_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, run_id: run_id, body: body],
call: {GitHub.Actions, :review_pending_deployments_for_run},
url: "/repos/#{owner}/#{repo}/actions/runs/#{run_id}/pending_deployments",
body: body,
method: :post,
request: [{"application/json", :map}],
response: [{200, [{GitHub.Deployment, :t}]}],
opts: opts
})
end
@doc """
Set allowed actions and reusable workflows for an organization
Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization)
"""
@spec set_allowed_actions_organization(String.t(), GitHub.SelectedActions.t(), keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_allowed_actions_organization(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :set_allowed_actions_organization},
url: "/orgs/#{org}/actions/permissions/selected-actions",
body: body,
method: :put,
request: [{"application/json", {GitHub.SelectedActions, :t}}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set allowed actions and reusable workflows for a repository
Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository)
"""
@spec set_allowed_actions_repository(
String.t(),
String.t(),
GitHub.SelectedActions.t(),
keyword
) :: :ok | {:error, GitHub.Error.t()}
def set_allowed_actions_repository(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :set_allowed_actions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/selected-actions",
body: body,
method: :put,
request: [{"application/json", {GitHub.SelectedActions, :t}}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set custom labels for a self-hosted runner for an organization
Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization)
"""
@spec set_custom_labels_for_self_hosted_runner_for_org(String.t(), integer, map, keyword) ::
{:ok, map} | {:error, GitHub.Error.t()}
def set_custom_labels_for_self_hosted_runner_for_org(org, runner_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, runner_id: runner_id, body: body],
call: {GitHub.Actions, :set_custom_labels_for_self_hosted_runner_for_org},
url: "/orgs/#{org}/actions/runners/#{runner_id}/labels",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Set custom labels for a self-hosted runner for a repository
Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository)
"""
@spec set_custom_labels_for_self_hosted_runner_for_repo(
String.t(),
String.t(),
integer,
map,
keyword
) :: {:ok, map} | {:error, GitHub.Error.t()}
def set_custom_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, runner_id: runner_id, body: body],
call: {GitHub.Actions, :set_custom_labels_for_self_hosted_runner_for_repo},
url: "/repos/#{owner}/#{repo}/actions/runners/#{runner_id}/labels",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [
{200, :map},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Set the customization template for an OIDC subject claim for a repository
Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository)
"""
@spec set_custom_oidc_sub_claim_for_repo(
String.t(),
String.t(),
GitHub.Actions.OIDCSubjectCustomizationForARepository.t(),
keyword
) :: {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}
def set_custom_oidc_sub_claim_for_repo(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :set_custom_oidc_sub_claim_for_repo},
url: "/repos/#{owner}/#{repo}/actions/oidc/customization/sub",
body: body,
method: :put,
request: [{"application/json", {GitHub.Actions.OIDCSubjectCustomizationForARepository, :t}}],
response: [
{201, {GitHub.EmptyObject, :t}},
{400, {:union, [{GitHub.BasicError, :t}, {GitHub.SCIM.Error, :t}]}},
{404, {GitHub.BasicError, :t}},
{422, {GitHub.ValidationError, :simple}}
],
opts: opts
})
end
@doc """
Set default workflow permissions for an organization
Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization)
"""
@spec set_github_actions_default_workflow_permissions_organization(
String.t(),
GitHub.Actions.SetDefaultWorkflowPermissions.t(),
keyword
) :: :ok | {:error, GitHub.Error.t()}
def set_github_actions_default_workflow_permissions_organization(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :set_github_actions_default_workflow_permissions_organization},
url: "/orgs/#{org}/actions/permissions/workflow",
body: body,
method: :put,
request: [{"application/json", {GitHub.Actions.SetDefaultWorkflowPermissions, :t}}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set default workflow permissions for a repository
Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository)
"""
@spec set_github_actions_default_workflow_permissions_repository(
String.t(),
String.t(),
GitHub.Actions.SetDefaultWorkflowPermissions.t(),
keyword
) :: :ok | {:error, GitHub.Error.t()}
def set_github_actions_default_workflow_permissions_repository(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :set_github_actions_default_workflow_permissions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/workflow",
body: body,
method: :put,
request: [{"application/json", {GitHub.Actions.SetDefaultWorkflowPermissions, :t}}],
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Set GitHub Actions permissions for an organization
Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization)
"""
@spec set_github_actions_permissions_organization(String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_github_actions_permissions_organization(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :set_github_actions_permissions_organization},
url: "/orgs/#{org}/actions/permissions",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set GitHub Actions permissions for a repository
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository)
"""
@spec set_github_actions_permissions_repository(String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_github_actions_permissions_repository(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :set_github_actions_permissions_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set selected repositories for an organization secret
Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret)
"""
@spec set_selected_repos_for_org_secret(String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_selected_repos_for_org_secret(org, secret_name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, secret_name: secret_name, body: body],
call: {GitHub.Actions, :set_selected_repos_for_org_secret},
url: "/orgs/#{org}/actions/secrets/#{secret_name}/repositories",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set selected repositories for an organization variable
Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their `visibility` field set to `selected`.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this
endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable)
"""
@spec set_selected_repos_for_org_variable(String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_selected_repos_for_org_variable(org, name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name, body: body],
call: {GitHub.Actions, :set_selected_repos_for_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}/repositories",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{204, :null}, {409, :null}],
opts: opts
})
end
@doc """
Set selected repositories enabled for GitHub Actions in an organization
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization)
"""
@spec set_selected_repositories_enabled_github_actions_organization(String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def set_selected_repositories_enabled_github_actions_organization(org, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, body: body],
call: {GitHub.Actions, :set_selected_repositories_enabled_github_actions_organization},
url: "/orgs/#{org}/actions/permissions/repositories",
body: body,
method: :put,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Set the level of access for workflows outside of the repository
Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
repository `administration` permission to use this endpoint.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository)
"""
@spec set_workflow_access_to_repository(
String.t(),
String.t(),
GitHub.Actions.Workflow.AccessToRepository.t(),
keyword
) :: :ok | {:error, GitHub.Error.t()}
def set_workflow_access_to_repository(owner, repo, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, body: body],
call: {GitHub.Actions, :set_workflow_access_to_repository},
url: "/repos/#{owner}/#{repo}/actions/permissions/access",
body: body,
method: :put,
request: [{"application/json", {GitHub.Actions.Workflow.AccessToRepository, :t}}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Update an environment variable
Updates an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#update-an-environment-variable)
"""
@spec update_environment_variable(integer, String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def update_environment_variable(repository_id, name, environment_name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [
repository_id: repository_id,
name: name,
environment_name: environment_name,
body: body
],
call: {GitHub.Actions, :update_environment_variable},
url: "/repositories/#{repository_id}/environments/#{environment_name}/variables/#{name}",
body: body,
method: :patch,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Update an organization variable
Updates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#update-an-organization-variable)
"""
@spec update_org_variable(String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def update_org_variable(org, name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [org: org, name: name, body: body],
call: {GitHub.Actions, :update_org_variable},
url: "/orgs/#{org}/actions/variables/#{name}",
body: body,
method: :patch,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
@doc """
Update a repository variable
Updates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
## Resources
* [API method documentation](https://docs.github.com/rest/actions/variables#update-a-repository-variable)
"""
@spec update_repo_variable(String.t(), String.t(), String.t(), map, keyword) ::
:ok | {:error, GitHub.Error.t()}
def update_repo_variable(owner, repo, name, body, opts \\ []) do
client = opts[:client] || @default_client
client.request(%{
args: [owner: owner, repo: repo, name: name, body: body],
call: {GitHub.Actions, :update_repo_variable},
url: "/repos/#{owner}/#{repo}/actions/variables/#{name}",
body: body,
method: :patch,
request: [{"application/json", :map}],
response: [{204, :null}],
opts: opts
})
end
end
