Package-level declarations
Types
This resource does not support importing. If you'd like to help contribute it, please visit our GitHub page!
This resource does not support importing. If you'd like to help contribute it, please visit our GitHub page!
Builder for ActionsEnvironmentSecretArgs.
Builder for ActionsEnvironmentSecret.
This resource allows you to create and manage GitHub Actions variables within your GitHub repository environments. You must have write access to a repository to use this resource.
This resource allows you to create and manage GitHub Actions variables within your GitHub repository environments. You must have write access to a repository to use this resource.
Builder for ActionsEnvironmentVariableArgs.
Builder for ActionsEnvironmentVariable.
This resource allows you to create and manage an OpenID Connect subject claim customization template within a GitHub organization. More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation.
This resource allows you to create and manage an OpenID Connect subject claim customization template within a GitHub organization. More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation.
This resource allows you to create and manage GitHub Actions permissions within your GitHub enterprise organizations. You must have admin access to an organization to use this resource.
This resource allows you to create and manage GitHub Actions permissions within your GitHub enterprise organizations. You must have admin access to an organization to use this resource.
Builder for ActionsOrganizationPermissionsArgs.
Builder for ActionsOrganizationPermissions.
This resource can be imported using an ID made up of the secret name:
This resource can be imported using an ID made up of the secret name:
Builder for ActionsOrganizationSecretArgs.
This resource allows you to manage repository allow list for existing GitHub Actions secrets within your GitHub organization. You must have write access to an organization secret to use this resource. This resource is only applicable when visibility
of the existing organization secret has been set to selected
.
This resource allows you to manage repository allow list for existing GitHub Actions secrets within your GitHub organization. You must have write access to an organization secret to use this resource. This resource is only applicable when visibility
of the existing organization secret has been set to selected
.
Builder for ActionsOrganizationSecret.
This resource allows you to create and manage GitHub Actions variables within your GitHub organization. You must have write access to a repository to use this resource.
This resource allows you to create and manage GitHub Actions variables within your GitHub organization. You must have write access to a repository to use this resource.
Builder for ActionsOrganizationVariableArgs.
Builder for ActionsOrganizationVariable.
This resource allows you to set the access level of a non-public repositories actions and reusable workflows for use in other repositories. You must have admin access to a repository to use this resource.
This resource allows you to set the access level of a non-public repositories actions and reusable workflows for use in other repositories. You must have admin access to a repository to use this resource.
Builder for ActionsRepositoryAccessLevelArgs.
Builder for ActionsRepositoryAccessLevel.
This resource allows you to create and manage an OpenID Connect subject claim customization template for a GitHub repository. More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation. The following table lists the behaviour of use_default
: | use_default
| include_claim_keys
| Template used | |---------------|----------------------|-----------------------------------------------------------| | true
| Unset | GitHub's default | | false
| Set | include_claim_keys
| | false
| Unset | Organization's default if set, otherwise GitHub's default |
This resource allows you to create and manage an OpenID Connect subject claim customization template for a GitHub repository. More information on integrating GitHub with cloud providers using OpenID Connect and a list of available claims is available in the Actions documentation. The following table lists the behaviour of use_default
: | use_default
| include_claim_keys
| Template used | |---------------|----------------------|-----------------------------------------------------------| | true
| Unset | GitHub's default | | false
| Set | include_claim_keys
| | false
| Unset | Organization's default if set, otherwise GitHub's default |
This resource allows you to enable and manage GitHub Actions permissions for a given repository. You must have admin access to an repository to use this resource.
This resource allows you to enable and manage GitHub Actions permissions for a given repository. You must have admin access to an repository to use this resource.
Builder for ActionsRepositoryPermissionsArgs.
Builder for ActionsRepositoryPermissions.
This resource allows you to create and manage GitHub Actions runner groups within your GitHub enterprise organizations. You must have admin access to an organization to use this resource.
This resource allows you to create and manage GitHub Actions runner groups within your GitHub enterprise organizations. You must have admin access to an organization to use this resource.
Builder for ActionsRunnerGroupArgs.
Builder for ActionsRunnerGroup.
This resource can be imported using an ID made up of the repository
and secret_name
:
This resource can be imported using an ID made up of the repository
and secret_name
:
Builder for ActionsSecretArgs.
Builder for ActionsSecret.
This resource allows you to create and manage GitHub Actions variables within your GitHub repositories. You must have write access to a repository to use this resource.
This resource allows you to create and manage GitHub Actions variables within your GitHub repositories. You must have write access to a repository to use this resource.
Builder for ActionsVariableArgs.
Builder for ActionsVariable.
GitHub App Installation Repositories can be imported using an ID made up of installation_id
, e.g.
GitHub App Installation Repositories can be imported using an ID made up of installation_id
, e.g.
Builder for AppInstallationRepositoriesArgs.
Builder for AppInstallationRepositories.
GitHub App Installation Repository can be imported using an ID made up of installation_id:repository
, e.g.
GitHub App Installation Repository can be imported using an ID made up of installation_id:repository
, e.g.
Builder for AppInstallationRepositoryArgs.
Builder for AppInstallationRepository.
This resource allows you to create and manage branches within your repository. Additional constraints can be applied to ensure your branch is created from another branch or commit.
Builder for BranchArgs.
Provides a GitHub branch default resource. This resource allows you to set the default branch for a given repository. Note that use of this resource is incompatible with the default_branch
option of the github.Repository
resource. Using both will result in plans always showing a diff.
Provides a GitHub branch default resource. This resource allows you to set the default branch for a given repository. Note that use of this resource is incompatible with the default_branch
option of the github.Repository
resource. Using both will result in plans always showing a diff.
Builder for BranchDefaultArgs.
Builder for BranchDefault.
GitHub Branch Protection can be imported using an ID made up of repository:pattern
, e.g.
GitHub Branch Protection can be imported using an ID made up of repository:pattern
, e.g.
Builder for BranchProtectionArgs.
Builder for BranchProtection.
Protects a GitHub branch. The github.BranchProtection
resource has moved to the GraphQL API, while this resource will continue to leverage the REST API. This resource allows you to configure branch protection for repositories in your organization. When applied, the branch will be protected from forced pushes and deletion. Additional constraints, such as required status checks or restrictions on users, teams, and apps, can also be configured.
Protects a GitHub branch. The github.BranchProtection
resource has moved to the GraphQL API, while this resource will continue to leverage the REST API. This resource allows you to configure branch protection for repositories in your organization. When applied, the branch will be protected from forced pushes and deletion. Additional constraints, such as required status checks or restrictions on users, teams, and apps, can also be configured.
Builder for BranchProtectionV3Args.
Builder for BranchProtectionV3.
Builder for Branch.
This resource can be imported using an ID made up of the secret name
This resource can be imported using an ID made up of the secret name
Builder for CodespacesOrganizationSecretArgs.
This resource allows you to manage repository allow list for existing GitHub Codespaces secrets within your GitHub organization. You must have write access to an organization secret to use this resource. This resource is only applicable when visibility
of the existing organization secret has been set to selected
.
This resource allows you to manage repository allow list for existing GitHub Codespaces secrets within your GitHub organization. You must have write access to an organization secret to use this resource. This resource is only applicable when visibility
of the existing organization secret has been set to selected
.
Builder for CodespacesOrganizationSecret.
This resource can be imported using an ID made up of the repository
and secret_name
:
This resource can be imported using an ID made up of the repository
and secret_name
:
Builder for CodespacesSecretArgs.
Builder for CodespacesSecret.
This resource can be imported using an ID made up of the secret name
This resource can be imported using an ID made up of the secret name
Builder for CodespacesUserSecretArgs.
Builder for CodespacesUserSecret.
Builder for DependabotOrganizationSecretArgs.
Builder for DependabotOrganizationSecret.
Builder for DependabotSecretArgs.
Builder for DependabotSecret.
This resource manages mappings between external groups for enterprise managed users and GitHub teams. It wraps the API detailed here. Note that this is a distinct resource from github.TeamSyncGroupMapping
. github.EmuGroupMapping
is special to the Enterprise Managed User (EMU) external group feature, whereas github.TeamSyncGroupMapping
is specific to Identity Provider Groups.
This resource manages mappings between external groups for enterprise managed users and GitHub teams. It wraps the API detailed here. Note that this is a distinct resource from github.TeamSyncGroupMapping
. github.EmuGroupMapping
is special to the Enterprise Managed User (EMU) external group feature, whereas github.TeamSyncGroupMapping
is specific to Identity Provider Groups.
Builder for EmuGroupMappingArgs.
Builder for EmuGroupMapping.
This resource allows you to create and manage a GitHub enterprise organization.
This resource allows you to create and manage a GitHub enterprise organization.
Builder for EnterpriseOrganizationArgs.
Builder for EnterpriseOrganization.
The provider type for the github package. By default, resources use package-wide configuration settings, however an explicit Provider
instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.
Builder for GithubProvider.
Provides a GitHub issue resource. This resource allows you to create and manage issue within your GitHub repository.
Builder for IssueArgs.
GitHub Issue Labels can be imported using an ID made up of repository:name
, e.g.
GitHub Issue Labels can be imported using an ID made up of repository:name
, e.g.
Builder for IssueLabelArgs.
Builder for IssueLabel.
Provides GitHub issue labels resource. This resource allows you to create and manage issue labels within your GitHub organization.
Provides GitHub issue labels resource. This resource allows you to create and manage issue labels within your GitHub organization.
Builder for IssueLabelsArgs.
Builder for IssueLabels.
Builder for Issue.
Provides a GitHub membership resource. This resource allows you to add/remove users from your organization. When applied, an invitation will be sent to the user to become part of the organization. When destroyed, either the invitation will be cancelled or the user will be removed.
Provides a GitHub membership resource. This resource allows you to add/remove users from your organization. When applied, an invitation will be sent to the user to become part of the organization. When destroyed, either the invitation will be cancelled or the user will be removed.
Builder for MembershipArgs.
Builder for Membership.
This resource allows you to create and manage blocks for GitHub organizations.
This resource allows you to create and manage blocks for GitHub organizations.
Builder for OrganizationBlockArgs.
Builder for OrganizationBlock.
This resource allows you to create and manage custom roles in a GitHub Organization for use in repositories.
This resource allows you to create and manage custom roles in a GitHub Organization for use in repositories.
Builder for OrganizationCustomRoleArgs.
Builder for OrganizationCustomRole.
This resource allows you to create and manage projects for GitHub organization.
This resource allows you to create and manage projects for GitHub organization.
Builder for OrganizationProjectArgs.
Builder for OrganizationProject.
Creates a GitHub organization ruleset. This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
Creates a GitHub organization ruleset. This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
Builder for OrganizationRulesetArgs.
Builder for OrganizationRuleset.
GitHub Security Manager Teams can be imported using the GitHub team ID e.g.
GitHub Security Manager Teams can be imported using the GitHub team ID e.g.
Builder for OrganizationSecurityManagerArgs.
Builder for OrganizationSecurityManager.
This resource allows you to create and manage settings for a GitHub Organization.
This resource allows you to create and manage settings for a GitHub Organization.
Builder for OrganizationSettingsArgs.
Builder for OrganizationSettings.
This resource allows you to create and manage webhooks for GitHub organization.
This resource allows you to create and manage webhooks for GitHub organization.
Builder for OrganizationWebhookArgs.
Builder for OrganizationWebhook.
This resource allows you to create and manage cards for GitHub projects.
This resource allows you to create and manage cards for GitHub projects.
Builder for ProjectCardArgs.
Builder for ProjectCard.
This resource allows you to create and manage columns for GitHub projects.
This resource allows you to create and manage columns for GitHub projects.
Builder for ProjectColumnArgs.
Builder for ProjectColumn.
The provider type for the github package. By default, resources use package-wide configuration settings, however an explicit Provider
instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.
Builder for ProviderArgs.
This resource allows you to create and manage a release in a specific GitHub repository.
Builder for ReleaseArgs.
Builder for Release.
This resource allows you to create and manage repositories within your GitHub organization or personal account.
This resource allows you to create and manage repositories within your GitHub organization or personal account.
Builder for RepositoryArgs.
This resource allows you to create and manage an autolink reference for a single repository.
This resource allows you to create and manage an autolink reference for a single repository.
Builder for RepositoryAutolinkReferenceArgs.
Builder for RepositoryAutolinkReference.
Provides a GitHub repository collaborator resource.
Provides a GitHub repository collaborator resource.
Builder for RepositoryCollaboratorArgs.
Builder for RepositoryCollaborator.
Provides a GitHub repository collaborators resource.
Provides a GitHub repository collaborators resource.
Builder for RepositoryCollaboratorsArgs.
Builder for RepositoryCollaborators.
Provides a GitHub repository deploy key resource. A deploy key is an SSH key that is stored on your server and grants access to a single GitHub repository. This key is attached directly to the repository instead of to a personal user account. This resource allows you to add/remove repository deploy keys. Further documentation on GitHub repository deploy keys:
Provides a GitHub repository deploy key resource. A deploy key is an SSH key that is stored on your server and grants access to a single GitHub repository. This key is attached directly to the repository instead of to a personal user account. This resource allows you to add/remove repository deploy keys. Further documentation on GitHub repository deploy keys:
Builder for RepositoryDeployKeyArgs.
Builder for RepositoryDeployKey.
This resource allows you to create and manage deployment branch policies.
This resource allows you to create and manage deployment branch policies.
This resource allows you to create and manage environments for a GitHub repository.
This resource allows you to create and manage environments for a GitHub repository.
Builder for RepositoryEnvironmentArgs.
This resource allows you to create and manage environment deployment branch policies for a GitHub repository.
This resource allows you to create and manage environment deployment branch policies for a GitHub repository.
Builder for RepositoryEnvironment.
/* This resource allows you to create and manage files within a GitHub repository.
/* This resource allows you to create and manage files within a GitHub repository.
Builder for RepositoryFileArgs.
Builder for RepositoryFile.
Provides a GitHub repository milestone resource. This resource allows you to create and manage milestones for a GitHub Repository within an organization or user account.
Provides a GitHub repository milestone resource. This resource allows you to create and manage milestones for a GitHub Repository within an organization or user account.
Builder for RepositoryMilestoneArgs.
Builder for RepositoryMilestone.
This resource allows you to create and manage projects for GitHub repository.
This resource allows you to create and manage projects for GitHub repository.
Builder for RepositoryProjectArgs.
Builder for RepositoryProject.
This resource allows you to create and manage PullRequests for repositories within your GitHub organization or personal account.
This resource allows you to create and manage PullRequests for repositories within your GitHub organization or personal account.
Builder for RepositoryPullRequestArgs.
Builder for RepositoryPullRequest.
Builder for Repository.
Creates a GitHub repository ruleset. This resource allows you to create and manage rulesets on the repository level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
Creates a GitHub repository ruleset. This resource allows you to create and manage rulesets on the repository level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
Builder for RepositoryRulesetArgs.
Builder for RepositoryRuleset.
This resource allows you to create and manage a repository tag protection for repositories within your GitHub organization or personal account.
This resource allows you to create and manage a repository tag protection for repositories within your GitHub organization or personal account.
Builder for RepositoryTagProtectionArgs.
Builder for RepositoryTagProtection.
Repository topics can be imported using the name
of the repository.
Repository topics can be imported using the name
of the repository.
Builder for RepositoryTopicsArgs.
Builder for RepositoryTopics.
This resource allows you to create and manage webhooks for repositories within your GitHub organization or personal account.
This resource allows you to create and manage webhooks for repositories within your GitHub organization or personal account.
Builder for RepositoryWebhookArgs.
Builder for RepositoryWebhook.
Provides a GitHub team resource. This resource allows you to add/remove teams from your organization. When applied, a new team will be created. When destroyed, that team will be removed.
Builder for TeamArgs.
~>Note Although the team id or team slug can be used it is recommended to use the team id. Using the team slug will result in terraform doing conversions between the team slug and team id. This will cause team members associations to the team to be destroyed and recreated on import. GitHub Team Membership can be imported using the team ID team id or team slug, e.g.
~>Note Although the team id or team slug can be used it is recommended to use the team id. Using the team slug will result in terraform doing conversions between the team slug and team id. This will cause team members associations to the team to be destroyed and recreated on import. GitHub Team Membership can be imported using the team ID team id or team slug, e.g.
Builder for TeamMembersArgs.
Provides a GitHub team membership resource. This resource allows you to add/remove users from teams in your organization. When applied, the user will be added to the team. If the user hasn't accepted their invitation to the organization, they won't be part of the team until they do. When destroyed, the user will be removed from the team.
Provides a GitHub team membership resource. This resource allows you to add/remove users from teams in your organization. When applied, the user will be added to the team. If the user hasn't accepted their invitation to the organization, they won't be part of the team until they do. When destroyed, the user will be removed from the team.
Builder for TeamMembershipArgs.
Builder for TeamMembership.
Builder for TeamMembers.
GitHub Team Repository can be imported using an ID made up of team_id:repository
or team_name:repository
, e.g.
GitHub Team Repository can be imported using an ID made up of team_id:repository
or team_name:repository
, e.g.
Builder for TeamRepositoryArgs.
Builder for TeamRepository.
Builder for Team.
This resource manages the team settings (in particular the request review delegation settings) within the organization Creating this resource will alter the team Code Review settings. The team must both belong to the same organization configured in the provider on GitHub.
This resource manages the team settings (in particular the request review delegation settings) within the organization Creating this resource will alter the team Code Review settings. The team must both belong to the same organization configured in the provider on GitHub.
Builder for TeamSettingsArgs.
Builder for TeamSettings.
This resource allows you to create and manage Identity Provider (IdP) group connections within your GitHub teams. You must have team synchronization enabled for organizations owned by enterprise accounts. To learn more about team synchronization between IdPs and GitHub, please refer to: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github
This resource allows you to create and manage Identity Provider (IdP) group connections within your GitHub teams. You must have team synchronization enabled for organizations owned by enterprise accounts. To learn more about team synchronization between IdPs and GitHub, please refer to: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github
Builder for TeamSyncGroupMappingArgs.
Builder for TeamSyncGroupMapping.
Provides a GitHub user's GPG key resource. This resource allows you to add/remove GPG keys from your user account.
Provides a GitHub user's GPG key resource. This resource allows you to add/remove GPG keys from your user account.
Builder for UserGpgKeyArgs.
Builder for UserGpgKey.
Builder for UserInvitationAccepterArgs.
Builder for UserInvitationAccepter.
Provides a GitHub user's SSH key resource. This resource allows you to add/remove SSH keys from your user account.
Provides a GitHub user's SSH key resource. This resource allows you to add/remove SSH keys from your user account.
Builder for UserSshKeyArgs.
Builder for UserSshKey.