Categorygithub.com/hadenlabs/terraform-github-repository
module
0.0.0-20220228034315-689542f1e6bc
Repository: https://github.com/hadenlabs/terraform-github-repository.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

Latest Release Lint CI Test pre-commit Conventional Commits KeepAChangelog Terraform Version

terraform-github-repository

Terraform module to provision an github repository.

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

Requirements

NameVersion
terraform>= 0.12.20, < 2.0
github>=4.5.0
local>=1.3.0

Providers

NameVersion
github>=4.5.0

Modules

No modules.

Resources

NameType
github_actions_secret.thisresource
github_branch.developresource
github_branch.gh_pagesresource
github_branch_default.develop_defaultresource
github_branch_protection.thisresource
github_issue_label.thisresource
github_repository.thisresource
github_repository_collaborator.thisresource
github_repository_deploy_key.thisresource
github_repository_file.thisresource
github_repository_project.thisresource

Inputs

NameDescriptionTypeDefaultRequired
add_labels_defaultadd labels defaultbooltrueno
branch_protectionbranch protectionsmap(any){}no
collaboratorsList of Collaborator Objects
list(object({
 username = string
 permission = string
 }))
[]no
default_branchName of the Default Branch of the Repositorystring"develop"no
deploy_keysThe name of repositories.
list(object({
 title = string
 key = string
 read_only = bool
 }))
[]no
descriptionThe description of the repository.stringn/ayes
fileslist files for repository
list(object({
 branch = string
 file = string
 content = string
 commit_message = string
 commit_author = string
 commit_email = string
 overwrite_on_create = bool
 }))
[]no
is_git_flowGit Flow - Github Flowboolfalseno
nameThe name of the repository.stringn/ayes
pagesConfiguration block for GitHub Pagesmap(any){}no
secretssecrets for repositorymap(any){}no
settingsCreate and manage settings.any{}no
topicstopics of project.list(string)[]no
typestypes of project.list(string)[]no
visibilityThe visibility of the repository private or public.string"private"no

Outputs

NameDescription
deploy_keyoutput instance deploy_key
filesoutput instance github files
instanceoutput instance repository
labelsoutput topics github repository
nameoutput name repository
secretsoutput instance github actions secrets
topicsoutput topics github repository

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

  1. Use the MAJOR version for incompatible changes.
  2. Use the MINOR version when adding functionality in a backwards compatible manner.
  3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

  • In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
  • In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2022 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like terraform-github-repository

Your feedback is appreciated

# Packages

No description provided by the author
No description provided by the author