Skip to content
This repository was archived by the owner on Apr 18, 2020. It is now read-only.

Commit 8dbd9a8

Browse files
committed
Cleaned up documentation
1 parent 1456b35 commit 8dbd9a8

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,8 @@ The following variables can be configured:
135135

136136
- **Description**: CodeBuild project name (won't create [default project][6])
137137
- **Default**: `""`
138-
- **Conflicts with**: `codebuild_compute_type`, `codebuild_image`
138+
- **Conflicts with**: `codebuild_compute_type`, `codebuild_image`,
139+
`codebuild_buildspec`
139140

140141
[6]: #default-project
141142

@@ -151,15 +152,16 @@ The following variables can be configured:
151152
- **Default**: `"aws/codebuild/ubuntu-base:14.04"`
152153
- **Conflicts with**: `codebuild_project`
153154

154-
#### `codebuild_bucket`
155+
#### `codebuild_buildspec`
155156

156-
- **Description**: S3 bucket to store status badge and artifacts
157-
- **Default**: `"github-ci"` (equal to namespace)
157+
- **Description**: Build specification declaration file ([file format][2])
158+
- **Default**: `"buildspec.yml"` (at repository root)
159+
- **Conflicts with**: `codebuild_project`
158160

159-
#### `codebuild_buildspec`
161+
#### `codebuild_bucket`
160162

161-
- **Description**: The build spec declaration to use for this build project's related builds.
162-
- **Default**: `""`
163+
- **Description**: S3 bucket to store status badge and artifacts
164+
- **Default**: `"${var.namespace}"` (equal to namespace)
163165

164166
### Outputs
165167

variables.tf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ variable "codebuild_image" {
7474
default = "aws/codebuild/ubuntu-base:14.04"
7575
}
7676

77-
# var.codebuild_bucket
78-
variable "codebuild_bucket" {
79-
description = "S3 bucket to store status badge and artifacts"
77+
# var.codebuild_buildspec
78+
variable "codebuild_buildspec" {
79+
description = "Build specification declaration file"
8080
default = ""
8181
}
8282

83-
# var.codebuild_buildspec
84-
variable "codebuild_buildspec" {
85-
description = "The build spec declaration to use for this build project's related builds."
83+
# var.codebuild_bucket
84+
variable "codebuild_bucket" {
85+
description = "S3 bucket to store status badge and artifacts"
8686
default = ""
8787
}

0 commit comments

Comments
 (0)