# `GitHubEx.Repos` [🔗](https://github.com/nshkrdotcom/github_ex/blob/v0.1.1/lib/github_ex/generated/repos.ex#L1) Generated Github Ex operations for repos. # `accept_invitation_for_authenticated_user` ```elixir @spec accept_invitation_for_authenticated_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Accept a repository invitation # `add_app_access_restrictions` ```elixir @spec add_app_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Add app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. # `add_collaborator` ```elixir @spec add_collaborator(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Add a repository collaborator Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} ``` Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. **Updating an existing collaborator's permission level** The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. **Rate limits** You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. # `add_status_check_contexts` ```elixir @spec add_status_check_contexts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Add status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `add_team_access_restrictions` ```elixir @spec add_team_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Add team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to child teams. # `add_user_access_restrictions` ```elixir @spec add_user_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Add user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Grants the specified people push access for this branch. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | # `cancel_pages_deployment` ```elixir @spec cancel_pages_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Cancel a GitHub Pages deployment Cancels a GitHub Pages deployment. The authenticated user must have write permissions for the GitHub Pages site. # `check_automated_security_fixes` ```elixir @spec check_automated_security_fixes(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Check if Dependabot security updates are enabled for a repository Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". # `check_collaborator` ```elixir @spec check_collaborator(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Check if a user is a repository collaborator For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. Team members will include the members of child teams. The authenticated user must have push access to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. # `check_immutable_releases` ```elixir @spec check_immutable_releases(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Check if immutable releases are enabled for a repository Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being enforced by the repository owner. The authenticated user must have admin read access to the repository. # `check_private_vulnerability_reporting` ```elixir @spec check_private_vulnerability_reporting(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Check if private vulnerability reporting is enabled for a repository Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". # `check_vulnerability_alerts` ```elixir @spec check_vulnerability_alerts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Check if vulnerability alerts are enabled for a repository Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". # `codeowners_errors` ```elixir @spec codeowners_errors(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List CODEOWNERS errors List any syntax errors that are detected in the CODEOWNERS file. For more information about the correct CODEOWNERS syntax, see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." # `compare_commits` ```elixir @spec compare_commits(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Compare two commits Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.diff`**: Returns the diff of the commit. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. **Working with large comparisons** To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | # `create_attestation` ```elixir @spec create_attestation(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create an attestation Store an artifact attestation and associate it with a repository. The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). # `create_autolink` ```elixir @spec create_autolink(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create an autolink reference for a repository Users with admin access to the repository can create an autolink. # `create_commit_comment` ```elixir @spec create_commit_comment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a commit comment Create a comment for a commit using its `:commit_sha`. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. # `create_commit_signature_protection` ```elixir @spec create_commit_signature_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. # `create_commit_status` ```elixir @spec create_commit_status(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a commit status Users with push access in a repository can create commit statuses for a given SHA. Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. # `create_deploy_key` ```elixir @spec create_deploy_key(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a deploy key You can create a read-only deploy key. # `create_deployment` ```elixir @spec create_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a deployment Deployments offer a few configurable parameters with certain defaults. The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request. The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`. The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: * Auto-merge option is enabled in the repository * Topic branch does not include the latest changes on the base branch, which is `master` in the response example * There are no merge conflicts If there are no new commits in the base branch, a new request to create a deployment should give a successful response. Merge conflict response: This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. Failed commit status checks: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. # `create_deployment_branch_policy` ```elixir @spec create_deployment_branch_policy(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a deployment branch policy Creates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `create_deployment_protection_rule` ```elixir @spec create_deployment_protection_rule(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a custom deployment protection rule on an environment Enable a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `create_deployment_status` ```elixir @spec create_deployment_status(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a deployment status Users with `push` access can create deployment statuses for a given deployment. OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. # `create_dispatch_event` ```elixir @spec create_dispatch_event(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a repository dispatch event You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. This input example shows how you can use the `client_payload` as a test to debug your workflow. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `create_for_authenticated_user` ```elixir @spec create_for_authenticated_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a repository for the authenticated user Creates a new repository for the authenticated user. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. # `create_fork` ```elixir @spec create_fork(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a fork Create a fork for the authenticated user. > [!NOTE] > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). > [!NOTE] > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. # `create_in_org` ```elixir @spec create_in_org(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create an organization repository Creates a new repository in the specified organization. The authenticated user must be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. # `create_or_update_environment` ```elixir @spec create_or_update_environment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create or update an environment Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](https://docs.github.com/actions/reference/environments#environment-protection-rules)." > [!NOTE] > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](https://docs.github.com/rest/deployments/branch-policies)." > [!NOTE] > To create or update secrets for an environment, see "[GitHub Actions secrets](https://docs.github.com/rest/actions/secrets)." OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `create_or_update_file_contents` ```elixir @spec create_or_update_file_contents(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create or update file contents Creates a new file or replaces an existing file in a repository. > [!NOTE] > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. # `create_org_ruleset` ```elixir @spec create_org_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create an organization repository ruleset Create a repository ruleset for an organization. # `create_pages_deployment` ```elixir @spec create_pages_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a GitHub Pages deployment Create a GitHub Pages deployment for a repository. The authenticated user must have write permission to the repository. # `create_pages_site` ```elixir @spec create_pages_site(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a GitHub Pages site Configures a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages)." The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `create_release` ```elixir @spec create_release(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a release Users with push access to the repository can create a release. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." # `create_repo_ruleset` ```elixir @spec create_repo_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a repository ruleset Create a ruleset for a repository. # `create_using_template` ```elixir @spec create_using_template(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a repository using a template Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. # `create_webhook` ```elixir @spec create_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Create a repository webhook Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap. # `custom_properties_for_repos_create_or_update_repository_values` ```elixir @spec custom_properties_for_repos_create_or_update_repository_values( term(), map(), keyword() ) :: {:ok, term()} | {:error, term()} ``` Create or update custom property values for a repository Create new or update existing custom property values for a repository. Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. # `custom_properties_for_repos_get_repository_values` ```elixir @spec custom_properties_for_repos_get_repository_values(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all custom property values for a repository Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint. # `decline_invitation_for_authenticated_user` ```elixir @spec decline_invitation_for_authenticated_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Decline a repository invitation # `delete` ```elixir @spec delete(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a repository Deleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a `403 Forbidden` response. OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. # `delete_access_restrictions` ```elixir @spec delete_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Disables the ability to restrict who can push to this branch. # `delete_admin_branch_protection` ```elixir @spec delete_admin_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. # `delete_an_environment` ```elixir @spec delete_an_environment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete an environment OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `delete_autolink` ```elixir @spec delete_autolink(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete an autolink reference from a repository This deletes a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators. # `delete_branch_protection` ```elixir @spec delete_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `delete_commit_comment` ```elixir @spec delete_commit_comment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a commit comment # `delete_commit_signature_protection` ```elixir @spec delete_commit_signature_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. # `delete_deploy_key` ```elixir @spec delete_deploy_key(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a deploy key Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. # `delete_deployment` ```elixir @spec delete_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a deployment If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. To set a deployment as inactive, you must: * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * Mark the active deployment as inactive by adding any non-successful deployment status. For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. # `delete_deployment_branch_policy` ```elixir @spec delete_deployment_branch_policy(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a deployment branch policy Deletes a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `delete_file` ```elixir @spec delete_file(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a file Deletes a file in a repository. You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. > [!NOTE] > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. # `delete_invitation` ```elixir @spec delete_invitation(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a repository invitation # `delete_org_ruleset` ```elixir @spec delete_org_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete an organization repository ruleset Delete a ruleset for an organization. # `delete_pages_site` ```elixir @spec delete_pages_site(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a GitHub Pages site Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages). The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `delete_pull_request_review_protection` ```elixir @spec delete_pull_request_review_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `delete_release` ```elixir @spec delete_release(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a release Users with push access to the repository can delete a release. # `delete_release_asset` ```elixir @spec delete_release_asset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a release asset # `delete_repo_ruleset` ```elixir @spec delete_repo_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a repository ruleset Delete a ruleset for a repository. # `delete_webhook` ```elixir @spec delete_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Delete a repository webhook Delete a webhook for an organization. The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. # `disable_automated_security_fixes` ```elixir @spec disable_automated_security_fixes(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Disable Dependabot security updates Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". # `disable_deployment_protection_rule` ```elixir @spec disable_deployment_protection_rule(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Disable a custom protection rule for an environment Disables a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `disable_immutable_releases` ```elixir @spec disable_immutable_releases(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Disable immutable releases Disables immutable releases for a repository. The authenticated user must have admin access to the repository. # `disable_private_vulnerability_reporting` ```elixir @spec disable_private_vulnerability_reporting(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Disable private vulnerability reporting for a repository Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". # `disable_vulnerability_alerts` ```elixir @spec disable_vulnerability_alerts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Disable vulnerability alerts Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". # `download_tarball_archive` ```elixir @spec download_tarball_archive(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Download a repository archive (tar) Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. > [!NOTE] > For private repositories, these links are temporary and expire after five minutes. # `download_zipball_archive` ```elixir @spec download_zipball_archive(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Download a repository archive (zip) Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. > [!NOTE] > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. # `enable_automated_security_fixes` ```elixir @spec enable_automated_security_fixes(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Enable Dependabot security updates Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". # `enable_immutable_releases` ```elixir @spec enable_immutable_releases(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Enable immutable releases Enables immutable releases for a repository. The authenticated user must have admin access to the repository. # `enable_private_vulnerability_reporting` ```elixir @spec enable_private_vulnerability_reporting(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Enable private vulnerability reporting for a repository Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." # `enable_vulnerability_alerts` ```elixir @spec enable_vulnerability_alerts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Enable vulnerability alerts Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". # `generate_release_notes` ```elixir @spec generate_release_notes(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Generate release notes content for a release Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. # `get` ```elixir @spec get(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. > [!NOTE] > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. # `get_access_restrictions` ```elixir @spec get_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists who has access to this protected branch. > [!NOTE] > Users, apps, and teams `restrictions` are only available for organization-owned repositories. # `get_admin_branch_protection` ```elixir @spec get_admin_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `get_all_deployment_protection_rules` ```elixir @spec get_all_deployment_protection_rules(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all deployment protection rules for an environment Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `get_all_environments` ```elixir @spec get_all_environments(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List environments Lists the environments for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `get_all_status_check_contexts` ```elixir @spec get_all_status_check_contexts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `get_all_topics` ```elixir @spec get_all_topics(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all repository topics # `get_apps_with_access_to_protected_branch` ```elixir @spec get_apps_with_access_to_protected_branch(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get apps with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. # `get_autolink` ```elixir @spec get_autolink(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get an autolink reference of a repository This returns a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators. # `get_branch` ```elixir @spec get_branch(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a branch # `get_branch_protection` ```elixir @spec get_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `get_branch_rules` ```elixir @spec get_branch_rules(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get rules for a branch Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" enforcement statuses are not returned. # `get_clones` ```elixir @spec get_clones(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get repository clones Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. # `get_code_frequency_stats` ```elixir @spec get_code_frequency_stats(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the weekly commit activity Returns a weekly aggregate of the number of additions and deletions pushed to a repository. > [!NOTE] > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. # `get_collaborator_permission_level` ```elixir @spec get_collaborator_permission_level(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get repository permissions for a user Checks the repository permission and role of a collaborator. The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. The `role_name` attribute provides the name of the assigned role, including custom roles. The `permission` can also be used to determine which base level of access the collaborator has to the repository. The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. # `get_combined_status_for_ref` ```elixir @spec get_combined_status_for_ref(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the combined status for a specific reference Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Additionally, a combined `state` is returned. The `state` is one of: * **failure** if any of the contexts report as `error` or `failure` * **pending** if there are no statuses or a context is `pending` * **success** if the latest status for all contexts is `success` # `get_commit` ```elixir @spec get_commit(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a commit Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. > [!NOTE] > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | # `get_commit_activity_stats` ```elixir @spec get_commit_activity_stats(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the last year of commit activity Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. # `get_commit_comment` ```elixir @spec get_commit_comment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a commit comment Gets a specified commit comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. # `get_commit_signature_protection` ```elixir @spec get_commit_signature_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get commit signature protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. > [!NOTE] > You must enable branch protection to require signed commits. # `get_community_profile_metrics` ```elixir @spec get_community_profile_metrics(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get community profile metrics Returns all community profile metrics for a repository. The repository cannot be a fork. The returned metrics include an overall health score, the repository description, the presence of documentation, the detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, README, and CONTRIBUTING files. The `health_percentage` score is defined as a percentage of how many of the recommended community health files are present. For more information, see "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." `content_reports_enabled` is only returned for organization-owned repositories. # `get_content` ```elixir @spec get_content(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get repository content Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. If the content is a directory: The response will be an array of objects, one object for each item in the directory. If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. **Notes**: - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - If the requested file's size is: - 1 MB or smaller: All features of this endpoint are supported. - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - Greater than 100 MB: This endpoint is not supported. # `get_contributors_stats` ```elixir @spec get_contributors_stats(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all contributor commit activity Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * `a` - Number of additions * `d` - Number of deletions * `c` - Number of commits > [!NOTE] > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. # `get_custom_deployment_protection_rule` ```elixir @spec get_custom_deployment_protection_rule(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a custom deployment protection rule Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `get_deploy_key` ```elixir @spec get_deploy_key(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a deploy key # `get_deployment` ```elixir @spec get_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a deployment # `get_deployment_branch_policy` ```elixir @spec get_deployment_branch_policy(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a deployment branch policy Gets a deployment branch or tag policy for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `get_deployment_status` ```elixir @spec get_deployment_status(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a deployment status Users with pull access can view a deployment status for a deployment: # `get_environment` ```elixir @spec get_environment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get an environment > [!NOTE] > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy)." Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `get_latest_pages_build` ```elixir @spec get_latest_pages_build(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get latest Pages build Gets information about the single most recent build of a GitHub Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `get_latest_release` ```elixir @spec get_latest_release(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the latest release View the latest published full release for the repository. The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. # `get_org_rule_suite` ```elixir @spec get_org_rule_suite(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get an organization rule suite Gets information about a suite of rule evaluations from within an organization. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." # `get_org_rule_suites` ```elixir @spec get_org_rule_suites(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List organization rule suites Lists suites of rule evaluations at the organization level. For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." # `get_org_ruleset` ```elixir @spec get_org_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get an organization repository ruleset Get a repository ruleset for an organization. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset. # `get_org_rulesets` ```elixir @spec get_org_rulesets(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all organization repository rulesets Get all the repository rulesets for an organization. # `get_pages` ```elixir @spec get_pages(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a GitHub Pages site Gets information about a GitHub Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `get_pages_build` ```elixir @spec get_pages_build(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get GitHub Pages build Gets information about a GitHub Pages build. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `get_pages_deployment` ```elixir @spec get_pages_deployment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the status of a GitHub Pages deployment Gets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site. # `get_pages_health_check` ```elixir @spec get_pages_health_check(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a DNS health check for GitHub Pages Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `get_participation_stats` ```elixir @spec get_participation_stats(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the weekly commit count Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. The array order is oldest week (index 0) to most recent week. The most recent week is seven days ago at UTC midnight to today at UTC midnight. # `get_pull_request_review_protection` ```elixir @spec get_pull_request_review_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `get_punch_card_stats` ```elixir @spec get_punch_card_stats(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get the hourly commit count for each day Each array contains the day number, hour number, and number of commits: * `0-6`: Sunday - Saturday * `0-23`: Hour of day * Number of commits For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. # `get_readme` ```elixir @spec get_readme(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository README Gets the preferred README for a repository. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). # `get_readme_in_directory` ```elixir @spec get_readme_in_directory(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository README for a directory Gets the README from a repository directory. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). # `get_release` ```elixir @spec get_release(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a release Gets a public release with the specified release ID. > [!NOTE] > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." # `get_release_asset` ```elixir @spec get_release_asset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a release asset To download the asset's binary content: - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. - Alternatively, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. # `get_release_by_tag` ```elixir @spec get_release_by_tag(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a release by tag name Get a published release with the specified tag. # `get_repo_rule_suite` ```elixir @spec get_repo_rule_suite(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository rule suite Gets information about a suite of rule evaluations from within a repository. For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." # `get_repo_rule_suites` ```elixir @spec get_repo_rule_suites(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository rule suites Lists suites of rule evaluations at the repository level. For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." # `get_repo_ruleset` ```elixir @spec get_repo_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository ruleset Get a ruleset for a repository. **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user making the API request has write access to the ruleset. # `get_repo_ruleset_history` ```elixir @spec get_repo_ruleset_history(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get repository ruleset history Get the history of a repository ruleset. # `get_repo_ruleset_version` ```elixir @spec get_repo_ruleset_version(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get repository ruleset version Get a version of a repository ruleset. # `get_repo_rulesets` ```elixir @spec get_repo_rulesets(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all repository rulesets Get all the rulesets for a repository. # `get_status_checks_protection` ```elixir @spec get_status_checks_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get status checks protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `get_teams_with_access_to_protected_branch` ```elixir @spec get_teams_with_access_to_protected_branch(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get teams with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams. # `get_top_paths` ```elixir @spec get_top_paths(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get top referral paths Get the top 10 popular contents over the last 14 days. # `get_top_referrers` ```elixir @spec get_top_referrers(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get top referral sources Get the top 10 referrers over the last 14 days. # `get_users_with_access_to_protected_branch` ```elixir @spec get_users_with_access_to_protected_branch(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get users with access to the protected branch Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Lists the people who have push access to this branch. # `get_views` ```elixir @spec get_views(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get page views Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. # `get_webhook` ```elixir @spec get_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a repository webhook Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." # `get_webhook_config_for_repo` ```elixir @spec get_webhook_config_for_repo(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a webhook configuration for a repository Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook)." OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. # `get_webhook_delivery` ```elixir @spec get_webhook_delivery(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get a delivery for a repository webhook Returns a delivery for a webhook configured in a repository. # `list_activities` ```elixir @spec list_activities(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository activities Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." # `list_attestations` ```elixir @spec list_attestations(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List attestations List a collection of artifact attestations with a given subject digest that are associated with a repository. The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). # `list_autolinks` ```elixir @spec list_autolinks(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Get all autolinks of a repository Gets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators. # `list_branches` ```elixir @spec list_branches(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List branches # `list_branches_for_head_commit` ```elixir @spec list_branches_for_head_commit(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List branches for HEAD commit Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. # `list_collaborators` ```elixir @spec list_collaborators(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository collaborators For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. # `list_comments_for_commit` ```elixir @spec list_comments_for_commit(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List commit comments Lists the comments for a specified commit. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. # `list_commit_comments_for_repo` ```elixir @spec list_commit_comments_for_repo(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List commit comments for a repository Lists the commit comments for a specified repository. Comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. # `list_commit_statuses_for_ref` ```elixir @spec list_commit_statuses_for_ref(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List commit statuses for a reference Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. # `list_commits` ```elixir @spec list_commits(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List commits **Signature verification object** The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: | Name | Type | Description | | ---- | ---- | ----------- | | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: | Value | Description | | ----- | ----------- | | `expired_key` | The key that made the signature is expired. | | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | `gpgverify_error` | There was an error communicating with the signature verification service. | | `gpgverify_unavailable` | The signature verification service is currently unavailable. | | `unsigned` | The object does not include a signature. | | `unknown_signature_type` | A non-PGP signature was found in the commit. | | `no_user` | No user was associated with the `committer` email address in the commit. | | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | | `unknown_key` | The key that made the signature has not been registered with any user's account. | | `malformed_signature` | There was an error parsing the signature. | | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | `valid` | None of the above errors applied, so the signature is considered to be verified. | # `list_contributors` ```elixir @spec list_contributors(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository contributors Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance. GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. # `list_custom_deployment_rule_integrations` ```elixir @spec list_custom_deployment_rule_integrations(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List custom deployment rule integrations available for an environment Gets all custom deployment protection rule integrations that are available for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `list_deploy_keys` ```elixir @spec list_deploy_keys(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List deploy keys # `list_deployment_branch_policies` ```elixir @spec list_deployment_branch_policies(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List deployment branch policies Lists the deployment branch policies for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. # `list_deployment_statuses` ```elixir @spec list_deployment_statuses(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List deployment statuses Users with pull access can view deployment statuses for a deployment: # `list_deployments` ```elixir @spec list_deployments(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List deployments Simple filtering of deployments is available via query parameters: # `list_for_authenticated_user` ```elixir @spec list_for_authenticated_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repositories for the authenticated user Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. # `list_for_org` ```elixir @spec list_for_org(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List organization repositories Lists repositories for the specified organization. > [!NOTE] > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." # `list_for_user` ```elixir @spec list_for_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repositories for a user Lists public repositories for the specified user. # `list_forks` ```elixir @spec list_forks(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List forks # `list_invitations` ```elixir @spec list_invitations(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository invitations When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. # `list_invitations_for_authenticated_user` ```elixir @spec list_invitations_for_authenticated_user(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository invitations for the authenticated user When authenticating as a user, this endpoint will list all currently open repository invitations for that user. # `list_languages` ```elixir @spec list_languages(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository languages Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. # `list_pages_builds` ```elixir @spec list_pages_builds(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List GitHub Pages builds Lists builts of a GitHub Pages site. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `list_public` ```elixir @spec list_public(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List public repositories Lists all public repositories in the order that they were created. Note: - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. # `list_pull_requests_associated_with_commit` ```elixir @spec list_pull_requests_associated_with_commit(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List pull requests associated with a commit Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. # `list_release_assets` ```elixir @spec list_release_assets(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List release assets # `list_releases` ```elixir @spec list_releases(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List releases This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. # `list_tags` ```elixir @spec list_tags(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository tags # `list_teams` ```elixir @spec list_teams(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository teams Lists the teams that have access to the specified repository and that are also visible to the authenticated user. For a public repository, a team is listed only if that team added the public repository explicitly. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. # `list_webhook_deliveries` ```elixir @spec list_webhook_deliveries(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List deliveries for a repository webhook Returns a list of webhook deliveries for a webhook configured in a repository. # `list_webhooks` ```elixir @spec list_webhooks(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` List repository webhooks Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. # `merge` ```elixir @spec merge(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Merge a branch # `merge_upstream` ```elixir @spec merge_upstream(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Sync a fork branch with the upstream repository Sync a branch of a forked repository to keep it up-to-date with the upstream repository. # `ping_webhook` ```elixir @spec ping_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Ping a repository webhook This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. # `redeliver_webhook_delivery` ```elixir @spec redeliver_webhook_delivery(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Redeliver a delivery for a repository webhook Redeliver a webhook delivery for a webhook configured in a repository. # `remove_app_access_restrictions` ```elixir @spec remove_app_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. # `remove_collaborator` ```elixir @spec remove_collaborator(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove a repository collaborator Removes a collaborator from a repository. To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. This endpoint also: - Cancels any outstanding invitations sent by the collaborator - Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions to packages Removing a user as a collaborator has the following effects on forks: - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - If the user had their own fork of the repository, the fork will be deleted. - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. > [!NOTE] > A user can still have access to the repository through organization permissions like base repository permissions. Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". # `remove_status_check_contexts` ```elixir @spec remove_status_check_contexts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `remove_status_check_protection` ```elixir @spec remove_status_check_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove status check protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `remove_team_access_restrictions` ```elixir @spec remove_team_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for child teams. # `remove_user_access_restrictions` ```elixir @spec remove_user_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Remove user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Removes the ability of a user to push to this branch. | Type | Description | | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | # `rename_branch` ```elixir @spec rename_branch(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Rename a branch Renames a branch in a repository. > [!NOTE] > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. # `replace_all_topics` ```elixir @spec replace_all_topics(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Replace all repository topics # `request_pages_build` ```elixir @spec request_pages_build(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Request a GitHub Pages build You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. # `set_admin_branch_protection` ```elixir @spec set_admin_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Set admin branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. # `set_app_access_restrictions` ```elixir @spec set_app_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Set app access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. # `set_status_check_contexts` ```elixir @spec set_status_check_contexts(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Set status check contexts Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. # `set_team_access_restrictions` ```elixir @spec set_team_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Set team access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. # `set_user_access_restrictions` ```elixir @spec set_user_access_restrictions(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Set user access restrictions Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------------------- | | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | # `stream_codeowners_errors` ```elixir @spec stream_codeowners_errors(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_all_environments` ```elixir @spec stream_get_all_environments(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_all_topics` ```elixir @spec stream_get_all_topics(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_branch_rules` ```elixir @spec stream_get_branch_rules(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_combined_status_for_ref` ```elixir @spec stream_get_combined_status_for_ref(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_org_rule_suites` ```elixir @spec stream_get_org_rule_suites(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_org_rulesets` ```elixir @spec stream_get_org_rulesets(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_repo_rule_suites` ```elixir @spec stream_get_repo_rule_suites(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_repo_ruleset_history` ```elixir @spec stream_get_repo_ruleset_history(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_get_repo_rulesets` ```elixir @spec stream_get_repo_rulesets(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_activities` ```elixir @spec stream_list_activities(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_attestations` ```elixir @spec stream_list_attestations(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_autolinks` ```elixir @spec stream_list_autolinks(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_branches` ```elixir @spec stream_list_branches(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_branches_for_head_commit` ```elixir @spec stream_list_branches_for_head_commit(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_collaborators` ```elixir @spec stream_list_collaborators(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_comments_for_commit` ```elixir @spec stream_list_comments_for_commit(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_commit_comments_for_repo` ```elixir @spec stream_list_commit_comments_for_repo(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_commit_statuses_for_ref` ```elixir @spec stream_list_commit_statuses_for_ref(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_commits` ```elixir @spec stream_list_commits(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_contributors` ```elixir @spec stream_list_contributors(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_custom_deployment_rule_integrations` ```elixir @spec stream_list_custom_deployment_rule_integrations(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_deploy_keys` ```elixir @spec stream_list_deploy_keys(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_deployment_branch_policies` ```elixir @spec stream_list_deployment_branch_policies(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_deployment_statuses` ```elixir @spec stream_list_deployment_statuses(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_deployments` ```elixir @spec stream_list_deployments(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_for_authenticated_user` ```elixir @spec stream_list_for_authenticated_user(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_for_org` ```elixir @spec stream_list_for_org(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_for_user` ```elixir @spec stream_list_for_user(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_forks` ```elixir @spec stream_list_forks(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_invitations` ```elixir @spec stream_list_invitations(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_invitations_for_authenticated_user` ```elixir @spec stream_list_invitations_for_authenticated_user(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_pages_builds` ```elixir @spec stream_list_pages_builds(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_public` ```elixir @spec stream_list_public(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_pull_requests_associated_with_commit` ```elixir @spec stream_list_pull_requests_associated_with_commit(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_release_assets` ```elixir @spec stream_list_release_assets(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_releases` ```elixir @spec stream_list_releases(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_tags` ```elixir @spec stream_list_tags(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_teams` ```elixir @spec stream_list_teams(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_webhook_deliveries` ```elixir @spec stream_list_webhook_deliveries(term(), map(), keyword()) :: Enumerable.t() ``` # `stream_list_webhooks` ```elixir @spec stream_list_webhooks(term(), map(), keyword()) :: Enumerable.t() ``` # `test_push_webhook` ```elixir @spec test_push_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Test the push repository webhook This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. > [!NOTE] > Previously `/repos/:owner/:repo/hooks/:hook_id/test` # `transfer` ```elixir @spec transfer(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Transfer a repository A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). # `update` ```elixir @spec update(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a repository **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. # `update_branch_protection` ```elixir @spec update_branch_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update branch protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. > [!NOTE] > Passing new arrays of `users` and `teams` replaces their previous values. > [!NOTE] > The list of users, apps, and teams in total is limited to 100 items. # `update_commit_comment` ```elixir @spec update_commit_comment(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a commit comment Updates the contents of a specified commit comment. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. # `update_deployment_branch_policy` ```elixir @spec update_deployment_branch_policy(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a deployment branch policy Updates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `update_information_about_pages_site` ```elixir @spec update_information_about_pages_site(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update information about a GitHub Pages site Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages). The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. # `update_invitation` ```elixir @spec update_invitation(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a repository invitation # `update_org_ruleset` ```elixir @spec update_org_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update an organization repository ruleset Update a ruleset for an organization. # `update_pull_request_review_protection` ```elixir @spec update_pull_request_review_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update pull request review protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. > [!NOTE] > Passing new arrays of `users` and `teams` replaces their previous values. # `update_release` ```elixir @spec update_release(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a release Users with push access to the repository can edit a release. # `update_release_asset` ```elixir @spec update_release_asset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a release asset Users with push access to the repository can edit a release asset. # `update_repo_ruleset` ```elixir @spec update_repo_ruleset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a repository ruleset Update a ruleset for a repository. # `update_status_check_protection` ```elixir @spec update_status_check_protection(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update status check protection Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. # `update_webhook` ```elixir @spec update_webhook(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a repository webhook Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." # `update_webhook_config_for_repo` ```elixir @spec update_webhook_config_for_repo(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Update a webhook configuration for a repository Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook)." OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. # `upload_release_asset` ```elixir @spec upload_release_asset(term(), map(), keyword()) :: {:ok, term()} | {:error, term()} ``` Upload a release asset This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: `application/zip` GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset. When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. **Notes:** * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. --- *Consult [api-reference.md](api-reference.md) for complete listing*