github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/providers/github/r/repository.html.markdown (about)

     1  ---
     2  layout: "github"
     3  page_title: "GitHub: github_repository"
     4  sidebar_current: "docs-github-resource-repository"
     5  description: |-
     6    Creates and manages repositories within Github organizations
     7  ---
     8  
     9  # github\_repository
    10  
    11  This resource allows you to create and manage repositories within your
    12  Github organization.
    13  
    14  This resource cannot currently be used to manage *personal* repositories,
    15  outside of organizations.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  resource "github_repository" "example" {
    21    name        = "example"
    22    description = "My awesome codebase"
    23  
    24    private = true
    25  }
    26  ```
    27  
    28  ## Argument Reference
    29  
    30  The following arguments are supported:
    31  
    32  * `name` - (Required) The name of the repository.
    33  
    34  * `description` - (Optional) A description of the repository.
    35  
    36  * `homepage_url` - (Optional) URL of a page describing the project.
    37  
    38  * `private` - (Optional) Set to `true` to create a private repository.
    39    Repositories are created as public (e.g. open source) by default.
    40  
    41  * `has_issues` - (Optional) Set to `true` to enable the Github Issues features
    42    on the repository.
    43  
    44  * `has_wiki` - (Optional) Set to `true` to enable the Github Wiki features on
    45    the repository.
    46  
    47  * `has_downloads` - (Optional) Set to `true` to enable the (deprecated)
    48    downloads features on the repository.
    49  
    50  * `auto_init` - (Optional) Meaningful only during create; set to `true` to
    51    produce an initial commit in the repository.
    52  
    53  ## Attributes Reference
    54  
    55  The following additional attributes are exported:
    56  
    57  * `full_name` - A string of the form "orgname/reponame".
    58  
    59  * `default_branch` - The name of the repository's default branch.
    60  
    61  * `ssh_clone_url` - URL that can be provided to `git clone` to clone the
    62    repository via SSH.
    63  
    64  * `http_clone_url` - URL that can be provided to `git clone` to clone the
    65    repository via HTTPS.
    66  
    67  * `git_clone_url` - URL that can be provided to `git clone` to clone the
    68    repository anonymously via the git protocol.
    69  
    70  * `svn_url` - URL that can be provided to `svn checkout` to check out
    71    the repository via Github's Subversion protocol emulation.