repository

akur8-oss/repository/github

Terraform Module HCL GITHUB

Terraform Module for managing Github Repositories and default settings.

Install
module "repository" {
source = "akur8-oss/repository/github"
version = "1.0.0"
}
plain text: /constructs/tfmod-akur8-oss-repository-github/install.txt
⭐ Source on GitHub 📦 Registry page
README

terraform-github-repository This module is used to create Github repositories with default settings. Usage Use the module ``hcl module "repo" { source = "./" name = "my-repo" } ` Requirements | Name | Version | |------|---------| | terraform | ~> 1.0 | | github | ~> 4.0 | Providers | Name | Version | |------|---------| | github | ~> 4.0 | Resources | Name | Type | |------|------| | github_branch.default | resource | | github_branch_default.this | resource | | github_repository.this | resource | | github_team.maintain | resource | | github_team.read | resource | | github_team.write | resource | | github_team_repository.maintain | resource | | github_team_repository.read | resource | | github_team_repository.write | resource | | github_team.maintain | data source | | github_team.read | data

Inputs (26)
NameTypeDescriptionDefault
gitignore_templatestringUse the name of the template without the extension. For example, `Haskell`. required
homepage_urlstringURL of a page describing the project. required
license_templatestringUse the name of the template without the extension. For example, `mit` or `mpl-2 required
templatestringName of the template to use to create the repository (formed as 'owner/repositor required
namestring(Required) The name of the repository. required
descriptionstringA description of the repository. required
has_projectsboolSet to `true` to enable the GitHub Projects features on the repository. Per the false
has_wikiboolSet to `true` to enable the GitHub Wiki features on the repository.false
teams_readlist(string)Slugs of the teams that will be granted the 'pull' privilege. If null, a team wi[]
archive_on_destroyboolSet to false to delete the repository instead of archiving on destroy.true
auto_initboolSet to `false` to prevent producing an initial commit in the repository.true
allow_squash_mergeboolSet to `false` to disable squash merges on the repository.true
default_branchstringThe name of the repository branch."main"
topicslist(string)The list of topics of the repository.[]
vulnerability_alertsboolSet to true to enable security alerts for vulnerable dependencies. Enabling requtrue
allow_rebase_mergeboolSet to `true` to disable rebase merges on the repository.false
has_downloadsboolSet to `true` to enable the (deprecated) downloads features on the repository.false
teams_maintainlist(string)Slugs of the teams that will be granted the 'maintain' privilege. If null, a tea[]
teams_writelist(string)Slugs of the teams that will be granted the 'write' privilege. If null, a team w[]
allow_merge_commitboolSet to `true` to enable merge commits on the repository.false
delete_branch_on_mergeboolAutomatically delete head branch after a pull request is merged. Defaults to trutrue
has_issuesboolSet to `true` to enable the GitHub Issues features on the repository.false
is_templateboolSet to `true` to tell GitHub that this is a template repository.false
visibilitystringCan be public or private. If your organization is associated with an enterprise "private"
allow_auto_mergeboolSet to `true` to allow auto-merging pull requests on the repository.false
archivedboolSpecifies if the repository should be archived. Defaults to false. NOTE Currentlfalse
Outputs (5)
http_clone_url — URL that can be provided to git clone to clone the repository via HTTPS.
git_clone_url — URL that can be provided to git clone to clone the repository anonymously via the git protocol.
html_url — URL to the repository on the web.
full_name — A string of the form 'orgname/reponame'.
ssh_clone_url — URL that can be provided to git clone to clone the repository via SSH.
Resources (5)
github_branchgithub_branch_defaultgithub_repositorygithub_teamgithub_team_repository
Topics & Tags
terraform-modules
Details
FrameworkTerraform Module
LanguageHCL
Version1.0.0
Cloud GITHUB
★ Stars1
Forks1
Total downloads479
Inputs26
Outputs5
Resources5
LicenseMIT
Namespaceakur8-oss
Updated