required_pull_request_reviews = object({ dismiss_stale_reviews = bool, dismissal_users = list(string), dismissal_teams = list(string), require_code_owner_reviews = bool, required_approving_review_count = number // NOTE: this must be 6 or less })
Template to use for initial .gitignore file for the Repository
string
""
has_downloads
Toggle to enable (deprecated) GitHub Downloads for the Repository
bool
false
has_issues
Toggle to enable GitHub Issues for the Repository
bool
true
has_projects
Toggle to enable GitHub Projects for the Repository
bool
false
has_wiki
Toggle to enable GitHub Wiki for the Repository
bool
true
homepage_url
URL of a page describing the Repository
string
""
is_template
Toggle to enable Template use for the Repository
bool
false
issue_labels
List of Issue Label Objects
list(object({ name = string, color = string }))
[]
license_template
Identifier to use for initial LICENSE file for the Repository
string
""
name
Name of the Repository
string
""
pages
Configuration block for GitHub Pages
map(any)
{}
projects
List of Project Objecs
list(object({ name = string, body = string }))
[]
repository_collaborators
List of Collaborator Objects
list(object({ username = string }))
[]
team_repository_teams
List of Team Repository Team Objects
list(object({ team_id = string }))
[]
template
Template Repository to use when creating the Repository
map(string)
{}
topics
List of Topics of the Repository
list(string)
[]
visibility
Toggle to create a Private Repository
string
"private"
vulnerability_alerts
Toggle to enable Vulnerability Alerts for the Repository
bool
true
Outputs
Name
Description
files
Map of Repository File names and corresponding SHA blobs
full_name
A string of the form "orgname/reponame"
git_clone_url
URL to clone the repository via the git protocol
html_url
URL to the repository on the web
http_clone_url
URL to clone the repository via HTTPs
name
A string of the form "reponame"
node_id
Node ID of the Repository
project_ids
List of Repository Project IDs
project_urls
List of Repository Project IDs
projects
Map of Repository Project IDs, and corresponding URLs
repo_id
ID of the Repository
ssh_clone_url
URL to the repository to clone via SSH
svn_url
URL to check out the repository via GitHub's Subversion protocol emulation
Notes
Upgrading from 2.0.0 to 3.x.x
The 3.0.0 version of this module introduced support for the github_branch_default resource, a property that was initially handled through the github_repository resource.
For a better upgrade experience, it is advised to manually import this resource, using the import command:
Replace module.my_repository with the Module identifier in use and replace "my_repository" with the name of the repository the data is imported from.
For github_repository resources
Resources that are created with the template option enabled will be re-created (that is: destroyed, then created again) when the template stub is removed
Resources that are archived using the archive option cannot be unarchived, as the GitHub API does not currently support this
Starting with 3.0.0 of this Module, the default branch option is no longer set through the github_repository resource
For github_repository_deploy_key resources
Deploy Key resources expect a string for the deploy_key.key variable. Use the file function if key material is not available as a Terraform-variable already
For a step-by-step guide on how to generate SSH Keys, see this article on GitHub
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" basis, without WARRANTIES or conditions of any kind, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
请发表评论