From 78c39c7c621727d520876eef683f9683f8da636d Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 11 Oct 2016 10:16:09 -0700 Subject: [PATCH] website: docs for github_repository resource --- .../github/r/repository.html.markdown | 71 +++++++++++++++++++ website/source/layouts/github.erb | 3 + 2 files changed, 74 insertions(+) create mode 100644 website/source/docs/providers/github/r/repository.html.markdown diff --git a/website/source/docs/providers/github/r/repository.html.markdown b/website/source/docs/providers/github/r/repository.html.markdown new file mode 100644 index 000000000..6ccce9d63 --- /dev/null +++ b/website/source/docs/providers/github/r/repository.html.markdown @@ -0,0 +1,71 @@ +--- +layout: "github" +page_title: "GitHub: github_repository" +sidebar_current: "docs-github-resource-repository" +description: |- + Creates and manages repositories within Github organizations +--- + +# github\_repository + +This resource allows you to create and manage repositories within your +Github organization. + +This resource cannot currently be used to manage *personal* repositories, +outside of organizations. + +## Example Usage + +``` +resource "github_repository" "example" { + name = "example" + description = "My awesome codebase" + + private = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required) The name of the repository. + +* `description` - (Optional) A description of the repository. + +* `homepage_url` - (Optional) URL of a page describing the project. + +* `private` - (Optional) Set to `true` to create a private repository. + Repositories are created as public (e.g. open source) by default. + +* `has_issues` - (Optional) Set to `true` to enable the Github Issues features + on the repository. + +* `has_wiki` - (Optional) Set to `true` to enable the Github Wiki features on + the repository. + +* `has_downloads` - (Optional) Set to `true` to enable the (deprecated) + downloads features on the repository. + +* `auto_init` - (Optional) Meaningful only during create; set to `true` to + produce an initial commit in the repository. + +## Attributes Reference + +The following additional attributes are exported: + +* `full_name` - A string of the form "orgname/reponame". + +* `default_branch` - The name of the repository's default branch. + +* `ssh_clone_url` - URL that can be provided to `git clone` to clone the + repository via SSH. + +* `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. + +* `svn_url` - URL that can be provided to `svn checkout` to check out + the repository via Github's Subversion protocol emulation. diff --git a/website/source/layouts/github.erb b/website/source/layouts/github.erb index 4d0fdb2b1..ba93177f4 100644 --- a/website/source/layouts/github.erb +++ b/website/source/layouts/github.erb @@ -16,6 +16,9 @@ > github_membership + > + github_repository + > github_repository_collaborator