teamvulkan/terraform-github-repository
A module to create a github repository with a protected master
terraform-github-repository
Short lived feature branching support.
To use this against Github you need to have a Github Organisation.
It also includes branch protection for master. PRS are required to update the master branch.
Usage
module repo {
source = "JamesWoolfenden/repository/github"
}Requirements
No requirements.
Providers
| Name | Version |
|---|---|
| github | n/a |
Modules
No modules.
Resources
| Name | Type |
|---|---|
| github_branch_protection.repositories | resource |
| github_repository.repositories | resource |
Inputs
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| description | Put more effort into to descibing what your repo is about. | string |
n/a | yes |
| enforce_admins | n/a | bool |
false |
no |
| has_downloads | n/a | bool |
false |
no |
| has_issues | n/a | bool |
false |
no |
| has_projects | n/a | bool |
false |
no |
| has_wiki | This enables a wiki on your github repo. Why not. | bool |
n/a | yes |
| name | We are following tech-resource-topic after hashicorp. | string |
n/a | yes |
| pattern | n/a | string |
n/a | yes |
| private | Visibility to be one of [public private internal] | string |
"public" |
no |
| topics | n/a | list(any) |
n/a | yes |
Outputs
| Name | Description |
|---|---|
| full_name | A string of the form 'orgname/reponame'. |
| 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. |
| http_clone_url | URL that can be provided to git clone to clone the repository via HTTPS. |
| ssh_clone_url | URL that can be provided to git clone to clone the repository via SSH. |
Related Projects
Check out these related projects.
Help
Got a question?
Contributing
Bug Reports & Feature Requests
Copyrights
Copyright © 2019-2023 James Woolfenden
License
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
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.
