View Source GitHub.Actions (GitHub REST API Client v0.0.11)

Provides API endpoints related to actions

Link to this section Summary

Functions

Add custom labels to a self-hosted runner for an organization

Add custom labels to a self-hosted runner for a repository

Add selected repository to an organization secret

Add selected repository to an organization variable

Approve a workflow run for a fork pull request

Create or update an organization secret

Create an organization variable

Create a registration token for an organization

Create a registration token for a repository

Create a remove token for an organization

Create a remove token for a repository

Delete a GitHub Actions cache for a repository (using a cache ID)

Delete GitHub Actions caches for a repository (using a cache key)

Delete an organization secret

Delete an organization variable

Delete a self-hosted runner from an organization

Delete a self-hosted runner from a repository

Disable a selected repository for GitHub Actions in an organization

Enable a selected repository for GitHub Actions in an organization

List GitHub Actions caches for a repository

Get GitHub Actions cache usage for a repository

List repositories with GitHub Actions cache usage for an organization

Get GitHub Actions cache usage for an organization

Get allowed actions and reusable workflows for an organization

Get allowed actions and reusable workflows for a repository

Get the customization template for an OIDC subject claim for a repository

Get default workflow permissions for an organization

Get GitHub Actions permissions for an organization

Get GitHub Actions permissions for a repository

Get an organization public key

Get an organization variable

Get pending deployments for a workflow run

Get a repository public key

Get the review history for a workflow run

Get a self-hosted runner for an organization

Get the level of access for workflows outside of the repository

List artifacts for a repository

List labels for a self-hosted runner for an organization

List labels for a self-hosted runner for a repository

List organization secrets

List organization variables

List repository organization secrets

List repository organization variables

List repository required workflows

List runner applications for an organization

List runner applications for a repository

List selected repositories for an organization secret

List selected repositories for an organization variable

List selected repositories enabled for GitHub Actions in an organization

List self-hosted runners for an organization

List self-hosted runners for a repository

List workflow runs for a repository

Remove all custom labels from a self-hosted runner for an organization

Remove all custom labels from a self-hosted runner for a repository

Remove a custom label from a self-hosted runner for an organization

Remove a custom label from a self-hosted runner for a repository

Remove selected repository from an organization secret

Remove selected repository from an organization variable

Review custom deployment protection rules for a workflow run

Set allowed actions and reusable workflows for an organization

Set allowed actions and reusable workflows for a repository

Set custom labels for a self-hosted runner for an organization

Set custom labels for a self-hosted runner for a repository

Set the customization template for an OIDC subject claim for a repository

Set GitHub Actions permissions for an organization

Set GitHub Actions permissions for a repository

Set selected repositories for an organization secret

Set selected repositories for an organization variable

Set selected repositories enabled for GitHub Actions in an organization

Set the level of access for workflows outside of the repository

Update an organization variable

Link to this section Functions

Link to this function

add_custom_labels_to_self_hosted_runner_for_org(org, runner_id, body, opts \\ [])

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

Add custom labels to a self-hosted runner for an organization

resources

Resources

Link to this function

add_custom_labels_to_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ [])

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

Add custom labels to a self-hosted runner for a repository

resources

Resources

Link to this function

add_selected_repo_to_org_secret(org, secret_name, repository_id, opts \\ [])

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

Add selected repository to an organization secret

resources

Resources

Link to this function

add_selected_repo_to_org_variable(org, name, repository_id, opts \\ [])

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

Add selected repository to an organization variable

resources

Resources

Link to this function

add_selected_repo_to_required_workflow(org, required_workflow_id, repository_id, opts \\ [])

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

Add a repository to a required workflow

resources

Resources

Link to this function

approve_workflow_run(owner, repo, run_id, opts \\ [])

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

Approve a workflow run for a fork pull request

resources

Resources

Link to this function

cancel_workflow_run(owner, repo, run_id, opts \\ [])

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

Cancel a workflow run

resources

Resources

Link to this function

create_environment_variable(repository_id, environment_name, body, opts \\ [])

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

Create an environment variable

resources

Resources

Link to this function

create_or_update_environment_secret(repository_id, environment_name, secret_name, body, opts \\ [])

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

Create or update an environment secret

resources

Resources

Link to this function

create_or_update_org_secret(org, secret_name, body, opts \\ [])

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

Create or update an organization secret

resources

Resources

Link to this function

create_or_update_repo_secret(owner, repo, secret_name, body, opts \\ [])

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

Create or update a repository secret

resources

Resources

Link to this function

create_org_variable(org, body, opts \\ [])

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

Create an organization variable

resources

Resources

Link to this function

create_registration_token_for_org(org, opts \\ [])

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

Create a registration token for an organization

resources

Resources

Link to this function

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

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

Create a registration token for a repository

resources

Resources

Link to this function

create_remove_token_for_org(org, opts \\ [])

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

Create a remove token for an organization

resources

Resources

Link to this function

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

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

Create a remove token for a repository

resources

Resources

Link to this function

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

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

Create a repository variable

resources

Resources

Link to this function

create_required_workflow(org, body, opts \\ [])

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

Create a required workflow

resources

Resources

Link to this function

create_workflow_dispatch(owner, repo, workflow_id, body, opts \\ [])

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

Create a workflow dispatch event

resources

Resources

Link to this function

delete_actions_cache_by_id(owner, repo, cache_id, opts \\ [])

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

Delete a GitHub Actions cache for a repository (using a cache ID)

resources

Resources

Link to this function

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

View Source
@spec delete_actions_cache_by_key(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}

Delete GitHub Actions caches for a repository (using a cache key)

options

Options

  • key (String.t()): A key for identifying the cache.
  • ref (String.t()): 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

Resources

Link to this function

delete_artifact(owner, repo, artifact_id, opts \\ [])

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

Delete an artifact

resources

Resources

Link to this function

delete_environment_secret(repository_id, environment_name, secret_name, opts \\ [])

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

Delete an environment secret

resources

Resources

Link to this function

delete_environment_variable(repository_id, environment_name, name, opts \\ [])

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

Delete an environment variable

resources

Resources

Link to this function

delete_org_secret(org, secret_name, opts \\ [])

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

Delete an organization secret

resources

Resources

Link to this function

delete_org_variable(org, name, opts \\ [])

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

Delete an organization variable

resources

Resources

Link to this function

delete_repo_secret(owner, repo, secret_name, opts \\ [])

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

Delete a repository secret

resources

Resources

Link to this function

delete_repo_variable(owner, repo, name, opts \\ [])

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

Delete a repository variable

resources

Resources

Link to this function

delete_required_workflow(org, required_workflow_id, opts \\ [])

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

Delete a required workflow

resources

Resources

Link to this function

delete_self_hosted_runner_from_org(org, runner_id, opts \\ [])

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

Delete a self-hosted runner from an organization

resources

Resources

Link to this function

delete_self_hosted_runner_from_repo(owner, repo, runner_id, opts \\ [])

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

Delete a self-hosted runner from a repository

resources

Resources

Link to this function

delete_workflow_run(owner, repo, run_id, opts \\ [])

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

Delete a workflow run

resources

Resources

Link to this function

delete_workflow_run_logs(owner, repo, run_id, opts \\ [])

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

Delete workflow run logs

resources

Resources

Link to this function

disable_selected_repository_github_actions_organization(org, repository_id, opts \\ [])

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

Disable a selected repository for GitHub Actions in an organization

resources

Resources

Link to this function

disable_workflow(owner, repo, workflow_id, opts \\ [])

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

Disable a workflow

resources

Resources

Link to this function

download_artifact(owner, repo, artifact_id, archive_format, opts \\ [])

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

Download an artifact

resources

Resources

Link to this function

download_job_logs_for_workflow_run(owner, repo, job_id, opts \\ [])

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

Download job logs for a workflow run

resources

Resources

Link to this function

download_workflow_run_attempt_logs(owner, repo, run_id, attempt_number, opts \\ [])

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

Download workflow run attempt logs

resources

Resources

Link to this function

download_workflow_run_logs(owner, repo, run_id, opts \\ [])

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

Download workflow run logs

resources

Resources

Link to this function

enable_selected_repository_github_actions_organization(org, repository_id, opts \\ [])

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

Enable a selected repository for GitHub Actions in an organization

resources

Resources

Link to this function

enable_workflow(owner, repo, workflow_id, opts \\ [])

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

Enable a workflow

resources

Resources

Link to this function

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

View Source
@spec get_actions_cache_list(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}

List GitHub Actions caches for a repository

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • ref (String.t()): 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 (String.t()): An explicit key or prefix for identifying the cache
  • sort (String.t()): 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 (String.t()): The direction to sort the results by.

resources

Resources

Link to this function

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

View Source
@spec get_actions_cache_usage(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheUsageByRepository.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions cache usage for a repository

resources

Resources

Link to this function

get_actions_cache_usage_by_repo_for_org(org, opts \\ [])

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

List repositories with GitHub Actions cache usage for an organization

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

get_actions_cache_usage_for_org(org, opts \\ [])

View Source
@spec get_actions_cache_usage_for_org(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.CacheUsageOrgEnterprise.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions cache usage for an organization

resources

Resources

Link to this function

get_allowed_actions_organization(org, opts \\ [])

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

Get allowed actions and reusable workflows for an organization

resources

Resources

Link to this function

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

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

Get allowed actions and reusable workflows for a repository

resources

Resources

Link to this function

get_artifact(owner, repo, artifact_id, opts \\ [])

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

Get an artifact

resources

Resources

Link to this function

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

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

Get the customization template for an OIDC subject claim for a repository

resources

Resources

Link to this function

get_environment_public_key(repository_id, environment_name, opts \\ [])

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

Get an environment public key

resources

Resources

Link to this function

get_environment_secret(repository_id, environment_name, secret_name, opts \\ [])

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

Get an environment secret

resources

Resources

Link to this function

get_environment_variable(repository_id, environment_name, name, opts \\ [])

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

Get an environment variable

resources

Resources

Link to this function

get_github_actions_default_workflow_permissions_organization(org, opts \\ [])

View Source
@spec get_github_actions_default_workflow_permissions_organization(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()}
  | {:error, GitHub.Error.t()}

Get default workflow permissions for an organization

resources

Resources

Link to this function

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

View Source
@spec get_github_actions_default_workflow_permissions_repository(
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()}
  | {:error, GitHub.Error.t()}

Get default workflow permissions for a repository

resources

Resources

Link to this function

get_github_actions_permissions_organization(org, opts \\ [])

View Source
@spec get_github_actions_permissions_organization(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.OrganizationPermissions.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions permissions for an organization

resources

Resources

Link to this function

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

View Source
@spec get_github_actions_permissions_repository(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.RepositoryPermissions.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions permissions for a repository

resources

Resources

Link to this function

get_job_for_workflow_run(owner, repo, job_id, opts \\ [])

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

Get a job for a workflow run

resources

Resources

Link to this function

get_org_public_key(org, opts \\ [])

View Source
@spec get_org_public_key(
  String.t(),
  keyword()
) :: {:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}

Get an organization public key

resources

Resources

Link to this function

get_org_secret(org, secret_name, opts \\ [])

View Source
@spec get_org_secret(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Organization.ActionsSecret.t()} | {:error, GitHub.Error.t()}

Get an organization secret

resources

Resources

Link to this function

get_org_variable(org, name, opts \\ [])

View Source
@spec get_org_variable(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Organization.ActionsVariable.t()} | {:error, GitHub.Error.t()}

Get an organization variable

resources

Resources

Link to this function

get_pending_deployments_for_run(owner, repo, run_id, opts \\ [])

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

Get pending deployments for a workflow run

resources

Resources

Link to this function

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

View Source
@spec get_repo_public_key(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}

Get a repository public key

resources

Resources

Link to this function

get_repo_required_workflow(org, repo, required_workflow_id_for_repo, opts \\ [])

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

Get a required workflow entity for a repository

resources

Resources

Link to this function

get_repo_required_workflow_usage(org, repo, required_workflow_id_for_repo, opts \\ [])

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

Get required workflow usage

resources

Resources

Link to this function

get_repo_secret(owner, repo, secret_name, opts \\ [])

View Source
@spec get_repo_secret(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Secret.t()} | {:error, GitHub.Error.t()}

Get a repository secret

resources

Resources

Link to this function

get_repo_variable(owner, repo, name, opts \\ [])

View Source
@spec get_repo_variable(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Variable.t()} | {:error, GitHub.Error.t()}

Get a repository variable

resources

Resources

Link to this function

get_required_workflow(org, required_workflow_id, opts \\ [])

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

Get a required workflow

resources

Resources

Link to this function

get_reviews_for_run(owner, repo, run_id, opts \\ [])

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

Get the review history for a workflow run

resources

Resources

Link to this function

get_self_hosted_runner_for_org(org, runner_id, opts \\ [])

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

Get a self-hosted runner for an organization

resources

Resources

Link to this function

get_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

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

Get a self-hosted runner for a repository

resources

Resources

Link to this function

get_workflow(owner, repo, workflow_id, opts \\ [])

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

Get a workflow

resources

Resources

Link to this function

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

View Source
@spec get_workflow_access_to_repository(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.AccessToRepository.t()}
  | {:error, GitHub.Error.t()}

Get the level of access for workflows outside of the repository

resources

Resources

Link to this function

get_workflow_run(owner, repo, run_id, opts \\ [])

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

Get a workflow run

options

Options

  • exclude_pull_requests (boolean): If true pull requests are omitted from the response (empty array).

resources

Resources

Link to this function

get_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ [])

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

Get a workflow run attempt

options

Options

  • exclude_pull_requests (boolean): If true pull requests are omitted from the response (empty array).

resources

Resources

Link to this function

get_workflow_run_usage(owner, repo, run_id, opts \\ [])

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

Get workflow run usage

resources

Resources

Link to this function

get_workflow_usage(owner, repo, workflow_id, opts \\ [])

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

Get workflow usage

resources

Resources

Link to this function

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

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

List artifacts for a repository

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • name (String.t()): Filters artifacts by exact match on their name field.

resources

Resources

Link to this function

list_environment_secrets(repository_id, environment_name, opts \\ [])

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

List environment secrets

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_environment_variables(repository_id, environment_name, opts \\ [])

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

List environment variables

options

Options

  • per_page (integer): The number of results per page (max 30).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_jobs_for_workflow_run(owner, repo, run_id, opts \\ [])

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

List jobs for a workflow run

options

Options

  • filter (String.t()): 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 (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_jobs_for_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ [])

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

List jobs for a workflow run attempt

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_labels_for_self_hosted_runner_for_org(org, runner_id, opts \\ [])

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

List labels for a self-hosted runner for an organization

resources

Resources

Link to this function

list_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

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

List labels for a self-hosted runner for a repository

resources

Resources

Link to this function

list_org_secrets(org, opts \\ [])

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

List organization secrets

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_org_variables(org, opts \\ [])

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

List organization variables

options

Options

  • per_page (integer): The number of results per page (max 30).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List repository organization secrets

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List repository organization variables

options

Options

  • per_page (integer): The number of results per page (max 30).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_repo_required_workflows(org, repo, opts \\ [])

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

List repository required workflows

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List repository secrets

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List repository variables

options

Options

  • per_page (integer): The number of results per page (max 30).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List repository workflows

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_required_workflow_runs(owner, repo, required_workflow_id_for_repo, opts \\ [])

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

List workflow runs for a required workflow

options

Options

  • actor (String.t()): Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
  • branch (String.t()): Returns workflow runs associated with a branch. Use the name of the branch of the push.
  • event (String.t()): Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
  • status (String.t()): 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 (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • created (String.t()): Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
  • exclude_pull_requests (boolean): If true pull requests are omitted from the response (empty array).
  • check_suite_id (integer): Returns workflow runs with the check_suite_id that you specify.
  • head_sha (String.t()): Only returns workflow runs that are associated with the specified head_sha.

resources

Resources

Link to this function

list_required_workflows(org, opts \\ [])

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

List required workflows

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_runner_applications_for_org(org, opts \\ [])

View Source
@spec list_runner_applications_for_org(
  String.t(),
  keyword()
) :: {:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}

List runner applications for an organization

resources

Resources

Link to this function

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

View Source
@spec list_runner_applications_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}

List runner applications for a repository

resources

Resources

Link to this function

list_selected_repos_for_org_secret(org, secret_name, opts \\ [])

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

List selected repositories for an organization secret

options

Options

  • page (integer): Page number of the results to fetch.
  • per_page (integer): The number of results per page (max 100).

resources

Resources

Link to this function

list_selected_repos_for_org_variable(org, name, opts \\ [])

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

List selected repositories for an organization variable

options

Options

  • page (integer): Page number of the results to fetch.
  • per_page (integer): The number of results per page (max 100).

resources

Resources

Link to this function

list_selected_repositories_enabled_github_actions_organization(org, opts \\ [])

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

List selected repositories enabled for GitHub Actions in an organization

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_selected_repositories_required_workflow(org, required_workflow_id, opts \\ [])

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

List selected repositories for a required workflow

resources

Resources

Link to this function

list_self_hosted_runners_for_org(org, opts \\ [])

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

List self-hosted runners for an organization

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

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

List self-hosted runners for a repository

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_workflow_run_artifacts(owner, repo, run_id, opts \\ [])

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

List workflow run artifacts

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_workflow_runs(owner, repo, workflow_id, opts \\ [])

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

List workflow runs for a workflow

options

Options

  • actor (String.t()): Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
  • branch (String.t()): Returns workflow runs associated with a branch. Use the name of the branch of the push.
  • event (String.t()): Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
  • status (String.t()): 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 (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • created (String.t()): Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
  • exclude_pull_requests (boolean): If true pull requests are omitted from the response (empty array).
  • check_suite_id (integer): Returns workflow runs with the check_suite_id that you specify.
  • head_sha (String.t()): Only returns workflow runs that are associated with the specified head_sha.

resources

Resources

Link to this function

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

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

List workflow runs for a repository

options

Options

  • actor (String.t()): Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
  • branch (String.t()): Returns workflow runs associated with a branch. Use the name of the branch of the push.
  • event (String.t()): Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."
  • status (String.t()): 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 (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • created (String.t()): Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
  • exclude_pull_requests (boolean): If true pull requests are omitted from the response (empty array).
  • check_suite_id (integer): Returns workflow runs with the check_suite_id that you specify.
  • head_sha (String.t()): Only returns workflow runs that are associated with the specified head_sha.

resources

Resources

Link to this function

re_run_job_for_workflow_run(owner, repo, job_id, body, opts \\ [])

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

Re-run a job from a workflow run

resources

Resources

Link to this function

re_run_workflow(owner, repo, run_id, body, opts \\ [])

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

Re-run a workflow

resources

Resources

Link to this function

re_run_workflow_failed_jobs(owner, repo, run_id, body, opts \\ [])

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

Re-run failed jobs from a workflow run

resources

Resources

Link to this function

remove_all_custom_labels_from_self_hosted_runner_for_org(org, runner_id, opts \\ [])

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

Remove all custom labels from a self-hosted runner for an organization

resources

Resources

Link to this function

remove_all_custom_labels_from_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

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

Remove all custom labels from a self-hosted runner for a repository

resources

Resources

Link to this function

remove_custom_label_from_self_hosted_runner_for_org(org, runner_id, name, opts \\ [])

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

Remove a custom label from a self-hosted runner for an organization

resources

Resources

Link to this function

remove_custom_label_from_self_hosted_runner_for_repo(owner, repo, runner_id, name, opts \\ [])

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

Remove a custom label from a self-hosted runner for a repository

resources

Resources

Link to this function

remove_selected_repo_from_org_secret(org, secret_name, repository_id, opts \\ [])

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

Remove selected repository from an organization secret

resources

Resources

Link to this function

remove_selected_repo_from_org_variable(org, name, repository_id, opts \\ [])

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

Remove selected repository from an organization variable

resources

Resources

Link to this function

remove_selected_repo_from_required_workflow(org, required_workflow_id, repository_id, opts \\ [])

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

Remove a selected repository from required workflow

resources

Resources

Link to this function

review_custom_gates_for_run(owner, repo, run_id, body, opts \\ [])

View Source

Review custom deployment protection rules for a workflow run

resources

Resources

Link to this function

review_pending_deployments_for_run(owner, repo, run_id, body, opts \\ [])

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

Review pending deployments for a workflow run

resources

Resources

Link to this function

set_allowed_actions_organization(org, body, opts \\ [])

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

Set allowed actions and reusable workflows for an organization

resources

Resources

Link to this function

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

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

Set allowed actions and reusable workflows for a repository

resources

Resources

Link to this function

set_custom_labels_for_self_hosted_runner_for_org(org, runner_id, body, opts \\ [])

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

Set custom labels for a self-hosted runner for an organization

resources

Resources

Link to this function

set_custom_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ [])

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

Set custom labels for a self-hosted runner for a repository

resources

Resources

Link to this function

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

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

Set the customization template for an OIDC subject claim for a repository

resources

Resources

Link to this function

set_github_actions_default_workflow_permissions_organization(org, body, opts \\ [])

View Source
@spec set_github_actions_default_workflow_permissions_organization(
  String.t(),
  GitHub.Actions.SetDefaultWorkflowPermissions.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set default workflow permissions for an organization

resources

Resources

Link to this function

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

View Source
@spec set_github_actions_default_workflow_permissions_repository(
  String.t(),
  String.t(),
  GitHub.Actions.SetDefaultWorkflowPermissions.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set default workflow permissions for a repository

resources

Resources

Link to this function

set_github_actions_permissions_organization(org, body, opts \\ [])

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

Set GitHub Actions permissions for an organization

resources

Resources

Link to this function

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

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

Set GitHub Actions permissions for a repository

resources

Resources

Link to this function

set_selected_repos_for_org_secret(org, secret_name, body, opts \\ [])

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

Set selected repositories for an organization secret

resources

Resources

Link to this function

set_selected_repos_for_org_variable(org, name, body, opts \\ [])

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

Set selected repositories for an organization variable

resources

Resources

Link to this function

set_selected_repos_to_required_workflow(org, required_workflow_id, body, opts \\ [])

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

Sets repositories for a required workflow

resources

Resources

Link to this function

set_selected_repositories_enabled_github_actions_organization(org, body, opts \\ [])

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

Set selected repositories enabled for GitHub Actions in an organization

resources

Resources

Link to this function

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

View Source
@spec set_workflow_access_to_repository(
  String.t(),
  String.t(),
  GitHub.Actions.Workflow.AccessToRepository.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set the level of access for workflows outside of the repository

resources

Resources

Link to this function

update_environment_variable(repository_id, environment_name, name, body, opts \\ [])

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

Update an environment variable

resources

Resources

Link to this function

update_org_variable(org, name, body, opts \\ [])

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

Update an organization variable

resources

Resources

Link to this function

update_repo_variable(owner, repo, name, body, opts \\ [])

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

Update a repository variable

resources

Resources

Link to this function

update_required_workflow(org, required_workflow_id, body, opts \\ [])

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

Update a required workflow

resources

Resources