View Source GitHub.Repos (GitHub REST API Client v0.0.4)
Provides API endpoints related to repos
Link to this section Summary
Functions
Accept a repository invitation
Add app access restrictions
Add a repository collaborator
Add status check contexts
Add team access restrictions
Add user access restrictions
Check if a user is a repository collaborator
Check if vulnerability alerts are enabled for a repository
List CODEOWNERS errors
Compare two commits
Create an autolink reference for a repository
Create a commit comment
Create commit signature protection
Create a commit status
Create a deploy key
Create a deployment
Create a deployment branch policy
Create a deployment status
Create a repository dispatch event
Create a repository for the authenticated user
Create a fork
Create an organization repository
Create or update an environment
Create or update file contents
Create a GitHub Pages deployment
Create a GitHub Pages site
Create a release
Create a tag protection state for a repository
Create a repository using a template
Create a repository webhook
Decline a repository invitation
Delete a repository
Delete access restrictions
Delete admin branch protection
Delete an environment
Delete an autolink reference from a repository
Delete branch protection
Delete a commit comment
Delete commit signature protection
Delete a deploy key
Delete a deployment
Delete a deployment branch policy
Delete a file
Delete a repository invitation
Delete a GitHub Pages site
Delete pull request review protection
Delete a release
Delete a release asset
Delete a tag protection state for a repository
Delete a repository webhook
Disable automated security fixes
Disable Git LFS for a repository
Disable vulnerability alerts
Download a repository archive (tar)
Download a repository archive (zip)
Enable automated security fixes
Enable Git LFS for a repository
Enable vulnerability alerts
Generate release notes content for a release
Get a repository
Get access restrictions
Get admin branch protection
List environments
Get all status check contexts
Get all repository topics
Get apps with access to the protected branch
Get an autolink reference of a repository
Get a branch
Get branch protection
Get repository clones
Get the weekly commit activity
Get repository permissions for a user
Get the combined status for a specific reference
Get a commit
Get the last year of commit activity
Get a commit comment
Get commit signature protection
Get community profile metrics
Get repository content
Get all contributor commit activity
Get a deploy key
Get a deployment
Get a deployment branch policy
Get a deployment status
Get an environment
Get latest Pages build
Get the latest release
Get a GitHub Pages site
Get GitHub Pages build
Get a DNS health check for GitHub Pages
Get the weekly commit count
Get pull request review protection
Get the hourly commit count for each day
Get a repository README
Get a repository README for a directory
Get a release
Get a release asset
Get a release by tag name
Get status checks protection
Get teams with access to the protected branch
Get top referral paths
Get top referral sources
Get users with access to the protected branch
Get page views
Get a repository webhook
Get a webhook configuration for a repository
Get a delivery for a repository webhook
List all autolinks of a repository
List branches
List branches for HEAD commit
List repository collaborators
List commit comments
List commit comments for a repository
List commit statuses for a reference
List commits
List repository contributors
List deploy keys
List deployment branch policies
List deployment statuses
List deployments
List repositories for the authenticated user
List organization repositories
List repositories for a user
List forks
List repository invitations
List repository invitations for the authenticated user
List repository languages
List GitHub Pages builds
List public repositories
List pull requests associated with a commit
List release assets
List releases
List tag protection states for a repository
List repository tags
List repository teams
List deliveries for a repository webhook
List repository webhooks
Merge a branch
Sync a fork branch with the upstream repository
Ping a repository webhook
Redeliver a delivery for a repository webhook
Remove app access restrictions
Remove a repository collaborator
Remove status check contexts
Remove status check protection
Remove team access restrictions
Remove user access restrictions
Rename a branch
Replace all repository topics
Request a GitHub Pages build
Set admin branch protection
Set app access restrictions
Set status check contexts
Set team access restrictions
Set user access restrictions
Test the push repository webhook
Transfer a repository
Update a repository
Update branch protection
Update a commit comment
Update a deployment branch policy
Update information about a GitHub Pages site
Update a repository invitation
Update pull request review protection
Update a release
Update a release asset
Update status check protection
Update a repository webhook
Update a webhook configuration for a repository
Upload a release asset
Link to this section Functions
accept_invitation_for_authenticated_user(invitation_id, opts \\ [])
View Source@spec accept_invitation_for_authenticated_user( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Accept a repository invitation
resources
Resources
add_app_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec add_app_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Integration.t()]} | {:error, GitHub.Error.t()}
Add app access restrictions
resources
Resources
@spec add_collaborator(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Repository.Invitation.t()} | {:error, GitHub.Error.t()}
Add a repository collaborator
resources
Resources
@spec add_status_check_contexts( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [String.t()]} | {:error, GitHub.Error.t()}
Add status check contexts
resources
Resources
add_team_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec add_team_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
Add team access restrictions
resources
Resources
add_user_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec add_user_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
Add user access restrictions
resources
Resources
@spec check_collaborator(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Check if a user is a repository collaborator
resources
Resources
@spec check_vulnerability_alerts(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Check if vulnerability alerts are enabled for a repository
resources
Resources
@spec codeowners_errors(String.t(), String.t(), keyword()) :: {:ok, GitHub.CodeownersErrors.t()} | {:error, GitHub.Error.t()}
List CODEOWNERS errors
options
Options
ref
(String.t()): A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g.main
)
resources
Resources
@spec compare_commits(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Commit.Comparison.t()} | {:error, GitHub.Error.t()}
Compare two commits
options
Options
page
(integer): Page number of the results to fetch.per_page
(integer): The number of results per page (max 100).
resources
Resources
@spec create_autolink(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Autolink.t()} | {:error, GitHub.Error.t()}
Create an autolink reference for a repository
resources
Resources
@spec create_commit_comment(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Commit.Comment.t()} | {:error, GitHub.Error.t()}
Create a commit comment
resources
Resources
create_commit_signature_protection(owner, repo, branch, opts \\ [])
View Source@spec create_commit_signature_protection( String.t(), String.t(), String.t(), keyword() ) :: {:ok, GitHub.ProtectedBranch.AdminEnforced.t()} | {:error, GitHub.Error.t()}
Create commit signature protection
resources
Resources
@spec create_commit_status(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Status.t()} | {:error, GitHub.Error.t()}
Create a commit status
resources
Resources
@spec create_deploy_key(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.DeployKey.t()} | {:error, GitHub.Error.t()}
Create a deploy key
resources
Resources
@spec create_deployment(String.t(), String.t(), map(), keyword()) :: {:ok, map() | GitHub.Deployment.t()} | {:error, GitHub.Error.t()}
Create a deployment
resources
Resources
create_deployment_branch_policy(owner, repo, environment_name, body, opts \\ [])
View Source@spec create_deployment_branch_policy( String.t(), String.t(), String.t(), GitHub.Deployment.BranchPolicyNamePattern.t(), keyword() ) :: {:ok, GitHub.Deployment.BranchPolicy.t()} | {:error, GitHub.Error.t()}
Create a deployment branch policy
resources
Resources
create_deployment_status(owner, repo, deployment_id, body, opts \\ [])
View Source@spec create_deployment_status(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Deployment.Status.t()} | {:error, GitHub.Error.t()}
Create a deployment status
resources
Resources
@spec create_dispatch_event(String.t(), String.t(), map(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Create a repository dispatch event
resources
Resources
@spec create_for_authenticated_user( map(), keyword() ) :: {:ok, GitHub.Repository.t()} | {:error, GitHub.Error.t()}
Create a repository for the authenticated user
resources
Resources
@spec create_fork(String.t(), String.t(), map() | nil, keyword()) :: {:ok, GitHub.Repository.full()} | {:error, GitHub.Error.t()}
Create a fork
resources
Resources
@spec create_in_org(String.t(), map(), keyword()) :: {:ok, GitHub.Repository.t()} | {:error, GitHub.Error.t()}
Create an organization repository
resources
Resources
create_or_update_environment(owner, repo, environment_name, body, opts \\ [])
View Source@spec create_or_update_environment( String.t(), String.t(), String.t(), map() | nil, keyword() ) :: {:ok, GitHub.Environment.t()} | {:error, GitHub.Error.t()}
Create or update an environment
resources
Resources
create_or_update_file_contents(owner, repo, path, body, opts \\ [])
View Source@spec create_or_update_file_contents( String.t(), String.t(), String.t(), map(), keyword() ) :: {:ok, GitHub.FileCommit.t()} | {:error, GitHub.Error.t()}
Create or update file contents
resources
Resources
@spec create_pages_deployment(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Pages.Deployment.t()} | {:error, GitHub.Error.t()}
Create a GitHub Pages deployment
resources
Resources
@spec create_pages_site(String.t(), String.t(), map() | nil, keyword()) :: {:ok, GitHub.Page.t()} | {:error, GitHub.Error.t()}
Create a GitHub Pages site
resources
Resources
@spec create_release(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Release.t()} | {:error, GitHub.Error.t()}
Create a release
resources
Resources
@spec create_tag_protection(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.TagProtection.t()} | {:error, GitHub.Error.t()}
Create a tag protection state for a repository
resources
Resources
create_using_template(template_owner, template_repo, body, opts \\ [])
View Source@spec create_using_template(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Repository.t()} | {:error, GitHub.Error.t()}
Create a repository using a template
resources
Resources
@spec create_webhook(String.t(), String.t(), map() | nil, keyword()) :: {:ok, GitHub.Hook.t()} | {:error, GitHub.Error.t()}
Create a repository webhook
resources
Resources
decline_invitation_for_authenticated_user(invitation_id, opts \\ [])
View Source@spec decline_invitation_for_authenticated_user( integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Decline a repository invitation
resources
Resources
@spec delete(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a repository
resources
Resources
@spec delete_access_restrictions(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete access restrictions
resources
Resources
@spec delete_admin_branch_protection(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete admin branch protection
resources
Resources
@spec delete_an_environment(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete an environment
resources
Resources
@spec delete_autolink(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete an autolink reference from a repository
resources
Resources
@spec delete_branch_protection(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete branch protection
resources
Resources
@spec delete_commit_comment(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a commit comment
resources
Resources
delete_commit_signature_protection(owner, repo, branch, opts \\ [])
View Source@spec delete_commit_signature_protection( String.t(), String.t(), String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete commit signature protection
resources
Resources
@spec delete_deploy_key(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a deploy key
resources
Resources
@spec delete_deployment(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a deployment
resources
Resources
delete_deployment_branch_policy(owner, repo, environment_name, branch_policy_id, opts \\ [])
View Source@spec delete_deployment_branch_policy( String.t(), String.t(), String.t(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a deployment branch policy
resources
Resources
@spec delete_file(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.FileCommit.t()} | {:error, GitHub.Error.t()}
Delete a file
resources
Resources
@spec delete_invitation(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a repository invitation
resources
Resources
@spec delete_pages_site(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a GitHub Pages site
resources
Resources
delete_pull_request_review_protection(owner, repo, branch, opts \\ [])
View Source@spec delete_pull_request_review_protection( String.t(), String.t(), String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete pull request review protection
resources
Resources
@spec delete_release(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a release
resources
Resources
@spec delete_release_asset(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a release asset
resources
Resources
@spec delete_tag_protection(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a tag protection state for a repository
resources
Resources
@spec delete_webhook(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a repository webhook
resources
Resources
@spec disable_automated_security_fixes(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Disable automated security fixes
resources
Resources
@spec disable_lfs_for_repo(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Disable Git LFS for a repository
resources
Resources
@spec disable_vulnerability_alerts(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Disable vulnerability alerts
resources
Resources
@spec download_tarball_archive(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Download a repository archive (tar)
resources
Resources
@spec download_zipball_archive(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Download a repository archive (zip)
resources
Resources
@spec enable_automated_security_fixes(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Enable automated security fixes
resources
Resources
@spec enable_lfs_for_repo(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Enable Git LFS for a repository
resources
Resources
@spec enable_vulnerability_alerts(String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Enable vulnerability alerts
resources
Resources
@spec generate_release_notes(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Release.NotesContent.t()} | {:error, GitHub.Error.t()}
Generate release notes content for a release
resources
Resources
@spec get(String.t(), String.t(), keyword()) :: {:ok, GitHub.Repository.full()} | {:error, GitHub.Error.t()}
Get a repository
resources
Resources
@spec get_access_restrictions(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Branch.RestrictionPolicy.t()} | {:error, GitHub.Error.t()}
Get access restrictions
resources
Resources
@spec get_admin_branch_protection(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.ProtectedBranch.AdminEnforced.t()} | {:error, GitHub.Error.t()}
Get admin branch protection
resources
Resources
@spec get_all_environments(String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
List environments
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec get_all_status_check_contexts(String.t(), String.t(), String.t(), keyword()) :: {:ok, [String.t()]} | {:error, GitHub.Error.t()}
Get all status check contexts
resources
Resources
@spec get_all_topics(String.t(), String.t(), keyword()) :: {:ok, GitHub.Topic.t()} | {:error, GitHub.Error.t()}
Get all repository topics
options
Options
page
(integer): Page number of the results to fetch.per_page
(integer): The number of results per page (max 100).
resources
Resources
get_apps_with_access_to_protected_branch(owner, repo, branch, opts \\ [])
View Source@spec get_apps_with_access_to_protected_branch( String.t(), String.t(), String.t(), keyword() ) :: {:ok, [GitHub.Integration.t()]} | {:error, GitHub.Error.t()}
Get apps with access to the protected branch
resources
Resources
@spec get_autolink(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Autolink.t()} | {:error, GitHub.Error.t()}
Get an autolink reference of a repository
resources
Resources
@spec get_branch(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Branch.WithProtection.t()} | {:error, GitHub.Error.t()}
Get a branch
resources
Resources
@spec get_branch_protection(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Branch.Protection.t()} | {:error, GitHub.Error.t()}
Get branch protection
resources
Resources
@spec get_clones(String.t(), String.t(), keyword()) :: {:ok, GitHub.CloneTraffic.t()} | {:error, GitHub.Error.t()}
Get repository clones
options
Options
per
(String.t()): The time frame to display results for.
resources
Resources
@spec get_code_frequency_stats(String.t(), String.t(), keyword()) :: {:ok, map() | [[integer()]]} | {:error, GitHub.Error.t()}
Get the weekly commit activity
resources
Resources
get_collaborator_permission_level(owner, repo, username, opts \\ [])
View Source@spec get_collaborator_permission_level(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Repository.CollaboratorPermission.t()} | {:error, GitHub.Error.t()}
Get repository permissions for a user
resources
Resources
@spec get_combined_status_for_ref(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.CombinedCommitStatus.t()} | {:error, GitHub.Error.t()}
Get the combined status for a specific reference
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec get_commit(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Commit.t()} | {:error, GitHub.Error.t()}
Get a commit
options
Options
page
(integer): Page number of the results to fetch.per_page
(integer): The number of results per page (max 100).
resources
Resources
@spec get_commit_activity_stats(String.t(), String.t(), keyword()) :: {:ok, map() | [GitHub.Commit.Activity.t()]} | {:error, GitHub.Error.t()}
Get the last year of commit activity
resources
Resources
@spec get_commit_comment(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Commit.Comment.t()} | {:error, GitHub.Error.t()}
Get a commit comment
resources
Resources
@spec get_commit_signature_protection(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.ProtectedBranch.AdminEnforced.t()} | {:error, GitHub.Error.t()}
Get commit signature protection
resources
Resources
@spec get_community_profile_metrics(String.t(), String.t(), keyword()) :: {:ok, GitHub.CommunityProfile.t()} | {:error, GitHub.Error.t()}
Get community profile metrics
resources
Resources
@spec get_content(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Content.File.t() | GitHub.Content.Submodule.t() | GitHub.Content.Symlink.t() | [map()]} | {:error, GitHub.Error.t()}
Get repository content
options
Options
ref
(String.t()): The name of the commit/branch/tag. Default: the repository’s default branch (usuallymaster
)
resources
Resources
@spec get_contributors_stats(String.t(), String.t(), keyword()) :: {:ok, map() | [GitHub.ContributorActivity.t()]} | {:error, GitHub.Error.t()}
Get all contributor commit activity
resources
Resources
@spec get_deploy_key(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.DeployKey.t()} | {:error, GitHub.Error.t()}
Get a deploy key
resources
Resources
@spec get_deployment(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Deployment.t()} | {:error, GitHub.Error.t()}
Get a deployment
resources
Resources
get_deployment_branch_policy(owner, repo, environment_name, branch_policy_id, opts \\ [])
View Source@spec get_deployment_branch_policy( String.t(), String.t(), String.t(), integer(), keyword() ) :: {:ok, GitHub.Deployment.BranchPolicy.t()} | {:error, GitHub.Error.t()}
Get a deployment branch policy
resources
Resources
get_deployment_status(owner, repo, deployment_id, status_id, opts \\ [])
View Source@spec get_deployment_status(String.t(), String.t(), integer(), integer(), keyword()) :: {:ok, GitHub.Deployment.Status.t()} | {:error, GitHub.Error.t()}
Get a deployment status
resources
Resources
@spec get_environment(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Environment.t()} | {:error, GitHub.Error.t()}
Get an environment
resources
Resources
@spec get_latest_pages_build(String.t(), String.t(), keyword()) :: {:ok, GitHub.Pages.Build.t()} | {:error, GitHub.Error.t()}
Get latest Pages build
resources
Resources
@spec get_latest_release(String.t(), String.t(), keyword()) :: {:ok, GitHub.Release.t()} | {:error, GitHub.Error.t()}
Get the latest release
resources
Resources
@spec get_pages(String.t(), String.t(), keyword()) :: {:ok, GitHub.Page.t()} | {:error, GitHub.Error.t()}
Get a GitHub Pages site
resources
Resources
@spec get_pages_build(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Pages.Build.t()} | {:error, GitHub.Error.t()}
Get GitHub Pages build
resources
Resources
@spec get_pages_health_check(String.t(), String.t(), keyword()) :: {:ok, GitHub.EmptyObject.t() | GitHub.Pages.HealthCheck.t()} | {:error, GitHub.Error.t()}
Get a DNS health check for GitHub Pages
resources
Resources
@spec get_participation_stats(String.t(), String.t(), keyword()) :: {:ok, GitHub.ParticipationStats.t()} | {:error, GitHub.Error.t()}
Get the weekly commit count
resources
Resources
get_pull_request_review_protection(owner, repo, branch, opts \\ [])
View Source@spec get_pull_request_review_protection( String.t(), String.t(), String.t(), keyword() ) :: {:ok, GitHub.ProtectedBranch.PullRequestReview.t()} | {:error, GitHub.Error.t()}
Get pull request review protection
resources
Resources
@spec get_punch_card_stats(String.t(), String.t(), keyword()) :: {:ok, [[integer()]]} | {:error, GitHub.Error.t()}
Get the hourly commit count for each day
resources
Resources
@spec get_readme(String.t(), String.t(), keyword()) :: {:ok, GitHub.Content.File.t()} | {:error, GitHub.Error.t()}
Get a repository README
options
Options
ref
(String.t()): The name of the commit/branch/tag. Default: the repository’s default branch (usuallymaster
)
resources
Resources
@spec get_readme_in_directory(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Content.File.t()} | {:error, GitHub.Error.t()}
Get a repository README for a directory
options
Options
ref
(String.t()): The name of the commit/branch/tag. Default: the repository’s default branch (usuallymaster
)
resources
Resources
@spec get_release(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Release.t()} | {:error, GitHub.Error.t()}
Get a release
resources
Resources
@spec get_release_asset(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Release.Asset.t()} | {:error, GitHub.Error.t()}
Get a release asset
resources
Resources
@spec get_release_by_tag(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Release.t()} | {:error, GitHub.Error.t()}
Get a release by tag name
resources
Resources
@spec get_status_checks_protection(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.StatusCheckPolicy.t()} | {:error, GitHub.Error.t()}
Get status checks protection
resources
Resources
get_teams_with_access_to_protected_branch(owner, repo, branch, opts \\ [])
View Source@spec get_teams_with_access_to_protected_branch( String.t(), String.t(), String.t(), keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
Get teams with access to the protected branch
resources
Resources
@spec get_top_paths(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Content.Traffic.t()]} | {:error, GitHub.Error.t()}
Get top referral paths
resources
Resources
@spec get_top_referrers(String.t(), String.t(), keyword()) :: {:ok, [GitHub.ReferrerTraffic.t()]} | {:error, GitHub.Error.t()}
Get top referral sources
resources
Resources
get_users_with_access_to_protected_branch(owner, repo, branch, opts \\ [])
View Source@spec get_users_with_access_to_protected_branch( String.t(), String.t(), String.t(), keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
Get users with access to the protected branch
resources
Resources
@spec get_views(String.t(), String.t(), keyword()) :: {:ok, GitHub.ViewTraffic.t()} | {:error, GitHub.Error.t()}
Get page views
options
Options
per
(String.t()): The time frame to display results for.
resources
Resources
@spec get_webhook(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Hook.t()} | {:error, GitHub.Error.t()}
Get a repository webhook
resources
Resources
@spec get_webhook_config_for_repo(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Webhook.Config.t()} | {:error, GitHub.Error.t()}
Get a webhook configuration for a repository
resources
Resources
get_webhook_delivery(owner, repo, hook_id, delivery_id, opts \\ [])
View Source@spec get_webhook_delivery(String.t(), String.t(), integer(), integer(), keyword()) :: {:ok, GitHub.Hook.Delivery.t()} | {:error, GitHub.Error.t()}
Get a delivery for a repository webhook
resources
Resources
@spec list_autolinks(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Autolink.t()]} | {:error, GitHub.Error.t()}
List all autolinks of a repository
options
Options
page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_branches(String.t(), String.t(), keyword()) :: {:ok, [GitHub.ShortBranch.t()]} | {:error, GitHub.Error.t()}
List branches
options
Options
protected
(boolean): Setting totrue
returns only protected branches. When set tofalse
, only unprotected branches are returned. Omitting this parameter returns all branches.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_branches_for_head_commit(owner, repo, commit_sha, opts \\ [])
View Source@spec list_branches_for_head_commit(String.t(), String.t(), String.t(), keyword()) :: {:ok, [GitHub.Branch.Short.t()]} | {:error, GitHub.Error.t()}
List branches for HEAD commit
resources
Resources
@spec list_collaborators(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Collaborator.t()]} | {:error, GitHub.Error.t()}
List repository collaborators
options
Options
affiliation
(String.t()): Filter collaborators returned by their affiliation.outside
means all outside collaborators of an organization-owned repository.direct
means all collaborators with permissions to an organization-owned repository, regardless of organization membership status.all
means all collaborators the authenticated user can see.permission
(String.t()): Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_comments_for_commit(String.t(), String.t(), String.t(), keyword()) :: {:ok, [GitHub.Commit.Comment.t()]} | {:error, GitHub.Error.t()}
List commit comments
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_commit_comments_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Commit.Comment.t()]} | {:error, GitHub.Error.t()}
List commit comments for a repository
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_commit_statuses_for_ref(String.t(), String.t(), String.t(), keyword()) :: {:ok, [GitHub.Status.t()]} | {:error, GitHub.Error.t()}
List commit statuses for a reference
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_commits(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Commit.t()]} | {:error, GitHub.Error.t()}
List commits
options
Options
sha
(String.t()): SHA or branch to start listing commits from. Default: the repository’s default branch (usuallymain
).path
(String.t()): Only commits containing this file path will be returned.author
(String.t()): GitHub login or email address by which to filter by commit author.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.until
(String.t()): Only commits before this date will be returned. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_contributors(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Contributor.t()]} | {:error, GitHub.Error.t()}
List repository contributors
options
Options
anon
(String.t()): Set to1
ortrue
to include anonymous contributors in results.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_deploy_keys(String.t(), String.t(), keyword()) :: {:ok, [GitHub.DeployKey.t()]} | {:error, GitHub.Error.t()}
List deploy keys
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_deployment_branch_policies(owner, repo, environment_name, opts \\ [])
View Source@spec list_deployment_branch_policies(String.t(), String.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
List deployment branch policies
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_deployment_statuses(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Deployment.Status.t()]} | {:error, GitHub.Error.t()}
List deployment statuses
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_deployments(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Deployment.t()]} | {:error, GitHub.Error.t()}
List deployments
options
Options
sha
(String.t()): The SHA recorded at creation time.ref
(String.t()): The name of the ref. This can be a branch, tag, or SHA.task
(String.t()): The name of the task for the deployment (e.g.,deploy
ordeploy:migrations
).environment
(String.t() | nil): The name of the environment that was deployed to (e.g.,staging
orproduction
).per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_authenticated_user(keyword()) :: {:ok, [GitHub.Repository.t()]} | {:error, GitHub.Error.t()}
List repositories for the authenticated user
options
Options
visibility
(String.t()): Limit results to repositories with the specified visibility.affiliation
(String.t()): Comma-separated list of values. Can include:owner
: Repositories that are owned by the authenticated user.collaborator
: Repositories that the user has been added to as a collaborator.organization_member
: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.type
(String.t()): Limit results to repositories of the specified type. Will cause a422
error if used in the same request as visibility or affiliation.sort
(String.t()): The property to sort the results by.direction
(String.t()): The order to sort by. Default:asc
when usingfull_name
, otherwisedesc
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.before
(String.t()): Only show notifications updated before the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.
resources
Resources
@spec list_for_org( String.t(), keyword() ) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List organization repositories
options
Options
type
(String.t()): Specifies the types of repositories you want returned.sort
(String.t()): The property to sort the results by.direction
(String.t()): The order to sort by. Default:asc
when usingfull_name
, otherwisedesc
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_user( String.t(), keyword() ) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List repositories for a user
options
Options
type
(String.t()): Limit results to repositories of the specified type.sort
(String.t()): The property to sort the results by.direction
(String.t()): The order to sort by. Default:asc
when usingfull_name
, otherwisedesc
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_forks(String.t(), String.t(), keyword()) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List forks
options
Options
sort
(String.t()): The sort order.stargazers
will sort by star count.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_invitations(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Repository.Invitation.t()]} | {:error, GitHub.Error.t()}
List repository invitations
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_invitations_for_authenticated_user(keyword()) :: {:ok, [GitHub.Repository.Invitation.t()]} | {:error, GitHub.Error.t()}
List repository invitations for the authenticated user
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_languages(String.t(), String.t(), keyword()) :: {:ok, GitHub.Language.t()} | {:error, GitHub.Error.t()}
List repository languages
resources
Resources
@spec list_pages_builds(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Pages.Build.t()]} | {:error, GitHub.Error.t()}
List GitHub Pages builds
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_public(keyword()) :: {:ok, [GitHub.MinimalRepository.t()]} | {:error, GitHub.Error.t()}
List public repositories
options
Options
since
(integer): A repository ID. Only return repositories with an ID greater than this ID.
resources
Resources
list_pull_requests_associated_with_commit(owner, repo, commit_sha, opts \\ [])
View Source@spec list_pull_requests_associated_with_commit( String.t(), String.t(), String.t(), keyword() ) :: {:ok, [GitHub.PullRequest.simple()]} | {:error, GitHub.Error.t()}
List pull requests associated with a commit
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_release_assets(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Release.Asset.t()]} | {:error, GitHub.Error.t()}
List release assets
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_releases(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Release.t()]} | {:error, GitHub.Error.t()}
List releases
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_tag_protection(String.t(), String.t(), keyword()) :: {:ok, [GitHub.TagProtection.t()]} | {:error, GitHub.Error.t()}
List tag protection states for a repository
resources
Resources
@spec list_tags(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Tag.t()]} | {:error, GitHub.Error.t()}
List repository tags
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_teams(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
List repository teams
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_webhook_deliveries(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Hook.DeliveryItem.t()]} | {:error, GitHub.Error.t()}
List deliveries for a repository webhook
options
Options
per_page
(integer): The number of results per page (max 100).cursor
(String.t()): Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to thelink
header for the next and previous page cursors.redelivery
(boolean):
resources
Resources
@spec list_webhooks(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Hook.t()]} | {:error, GitHub.Error.t()}
List repository webhooks
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec merge(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Commit.t()} | {:error, GitHub.Error.t()}
Merge a branch
resources
Resources
@spec merge_upstream(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.MergedUpstream.t()} | {:error, GitHub.Error.t()}
Sync a fork branch with the upstream repository
resources
Resources
@spec ping_webhook(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Ping a repository webhook
resources
Resources
redeliver_webhook_delivery(owner, repo, hook_id, delivery_id, opts \\ [])
View Source@spec redeliver_webhook_delivery( String.t(), String.t(), integer(), integer(), keyword() ) :: {:ok, map()} | {:error, GitHub.Error.t()}
Redeliver a delivery for a repository webhook
resources
Resources
remove_app_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec remove_app_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Integration.t()]} | {:error, GitHub.Error.t()}
Remove app access restrictions
resources
Resources
@spec remove_collaborator(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove a repository collaborator
resources
Resources
remove_status_check_contexts(owner, repo, branch, body, opts \\ [])
View Source@spec remove_status_check_contexts( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [String.t()]} | {:error, GitHub.Error.t()}
Remove status check contexts
resources
Resources
@spec remove_status_check_protection(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove status check protection
resources
Resources
remove_team_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec remove_team_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
Remove team access restrictions
resources
Resources
remove_user_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec remove_user_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
Remove user access restrictions
resources
Resources
@spec rename_branch(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Branch.WithProtection.t()} | {:error, GitHub.Error.t()}
Rename a branch
resources
Resources
@spec replace_all_topics(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Topic.t()} | {:error, GitHub.Error.t()}
Replace all repository topics
resources
Resources
@spec request_pages_build(String.t(), String.t(), keyword()) :: {:ok, GitHub.Pages.BuildStatus.t()} | {:error, GitHub.Error.t()}
Request a GitHub Pages build
resources
Resources
@spec set_admin_branch_protection(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.ProtectedBranch.AdminEnforced.t()} | {:error, GitHub.Error.t()}
Set admin branch protection
resources
Resources
set_app_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec set_app_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Integration.t()]} | {:error, GitHub.Error.t()}
Set app access restrictions
resources
Resources
@spec set_status_check_contexts( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [String.t()]} | {:error, GitHub.Error.t()}
Set status check contexts
resources
Resources
set_team_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec set_team_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.Team.t()]} | {:error, GitHub.Error.t()}
Set team access restrictions
resources
Resources
set_user_access_restrictions(owner, repo, branch, body, opts \\ [])
View Source@spec set_user_access_restrictions( String.t(), String.t(), String.t(), map() | [String.t()], keyword() ) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
Set user access restrictions
resources
Resources
@spec test_push_webhook(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Test the push repository webhook
resources
Resources
@spec transfer(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.MinimalRepository.t()} | {:error, GitHub.Error.t()}
Transfer a repository
resources
Resources
@spec update(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Repository.full()} | {:error, GitHub.Error.t()}
Update a repository
resources
Resources
@spec update_branch_protection(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.ProtectedBranch.t()} | {:error, GitHub.Error.t()}
Update branch protection
resources
Resources
@spec update_commit_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Commit.Comment.t()} | {:error, GitHub.Error.t()}
Update a commit comment
resources
Resources
update_deployment_branch_policy(owner, repo, environment_name, branch_policy_id, body, opts \\ [])
View Source@spec update_deployment_branch_policy( String.t(), String.t(), String.t(), integer(), GitHub.Deployment.BranchPolicyNamePattern.t(), keyword() ) :: {:ok, GitHub.Deployment.BranchPolicy.t()} | {:error, GitHub.Error.t()}
Update a deployment branch policy
resources
Resources
update_information_about_pages_site(owner, repo, body, opts \\ [])
View Source@spec update_information_about_pages_site(String.t(), String.t(), map(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Update information about a GitHub Pages site
resources
Resources
@spec update_invitation(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Repository.Invitation.t()} | {:error, GitHub.Error.t()}
Update a repository invitation
resources
Resources
update_pull_request_review_protection(owner, repo, branch, body, opts \\ [])
View Source@spec update_pull_request_review_protection( String.t(), String.t(), String.t(), map(), keyword() ) :: {:ok, GitHub.ProtectedBranch.PullRequestReview.t()} | {:error, GitHub.Error.t()}
Update pull request review protection
resources
Resources
@spec update_release(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Release.t()} | {:error, GitHub.Error.t()}
Update a release
resources
Resources
@spec update_release_asset(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Release.Asset.t()} | {:error, GitHub.Error.t()}
Update a release asset
resources
Resources
update_status_check_protection(owner, repo, branch, body, opts \\ [])
View Source@spec update_status_check_protection( String.t(), String.t(), String.t(), map(), keyword() ) :: {:ok, GitHub.StatusCheckPolicy.t()} | {:error, GitHub.Error.t()}
Update status check protection
resources
Resources
@spec update_webhook(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Hook.t()} | {:error, GitHub.Error.t()}
Update a repository webhook
resources
Resources
update_webhook_config_for_repo(owner, repo, hook_id, body, opts \\ [])
View Source@spec update_webhook_config_for_repo( String.t(), String.t(), integer(), map(), keyword() ) :: {:ok, GitHub.Webhook.Config.t()} | {:error, GitHub.Error.t()}
Update a webhook configuration for a repository
resources
Resources
@spec upload_release_asset(String.t(), String.t(), integer(), String.t(), keyword()) :: {:ok, GitHub.Release.Asset.t()} | {:error, GitHub.Error.t()}
Upload a release asset
options
Options
name
(String.t()):label
(String.t()):