installation-token [object]
Authentication token for a GitHub App installed on a user or org.
Attributes
app-permissions [object]
The permissions granted to the user-to-server access token.
Attributes
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
The level of permission to grant the access token for checks on code.
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
The level of permission to grant the access token for deployments and deployment statuses.
The level of permission to grant the access token for managing repository environments.
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
The level of permission to grant the access token for organization teams and members.
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
The level of permission to grant the access token to manage access to an organization.
The level of permission to grant the access token to view and manage announcement banners for an organization.
The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
The level of permission to grant the access token to manage the post-receive hooks for an organization.
The level of permission to grant the access token for organization packages published to GitHub Packages.
The level of permission to grant the access token for viewing an organization's plan.
The level of permission to grant the access token to manage organization projects and projects beta (where available).
The level of permission to grant the access token to manage organization secrets.
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
The level of permission to grant the access token to view and manage users blocked by the organization.
The level of permission to grant the access token for packages published to GitHub Packages.
The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
The level of permission to grant the access token to view and manage announcement banners for a repository.
The level of permission to grant the access token to manage the post-receive hooks for a repository.
The level of permission to grant the access token to manage repository projects, columns, and cards.
The level of permission to grant the access token to view and manage secret scanning alerts.
The level of permission to grant the access token to manage repository secrets.
The level of permission to grant the access token to view and manage security events like code scanning alerts.
The level of permission to grant the access token to manage just a single file.
The level of permission to grant the access token for commit statuses.
The level of permission to grant the access token to manage team discussions and related comments.
The level of permission to grant the access token to manage Dependabot alerts.
The level of permission to grant the access token to update GitHub Actions workflow files.
repository [object]
A repository on GitHub.
Attributes
Whether to allow Auto-merge to be used on pull requests.
Whether to allow forking this repo
Whether to allow merge commits for pull requests.
Whether to allow rebase merges for pull requests.
Whether to allow squash merges for pull requests.
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
Whether anonymous git access is enabled for this repository
Whether the repository is archived.
The default branch of the repository.
Whether to delete head branches when pull requests are merged
Returns whether or not this repository disabled.
Whether discussions are enabled.
Whether downloads are enabled.
Whether issues are enabled.
Whether projects are enabled.
Whether the wiki is enabled.
Unique identifier of the repository
Whether this repository acts as a template that can be used to generate new repositories.
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
The name of the repository.
Whether the repository is private or public.
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
The repository visibility: public, private, or internal.
Whether to require contributors to sign off on web-based commits