Add badge URL (#31)

* Add badge URL * add badge_enabled * Default false
cloudposse · Jan 12, 2019 · 92cc9af · 92cc9af
1 parent a761530
commit 92cc9af
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -112,7 +112,6 @@ Available targets:
   lint                                Lint terraform code
 
 ```
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -121,6 +120,7 @@ Available targets:
 | attributes | Additional attributes (e.g. `policy` or `role`) | list | `<list>` | no |
 | aws_account_id | (Optional) AWS Account ID. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `` | no |
 | aws_region | (Optional) AWS Region, e.g. us-east-1. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `` | no |
+| badge_enabled | Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled. | string | `false` | no |
 | build_compute_type | Instance type of the build instance | string | `BUILD_GENERAL1_SMALL` | no |
 | build_image | Docker image for build environment, e.g. 'aws/codebuild/docker:1.12.1' or 'aws/codebuild/eb-nodejs-6.10.0-amazonlinux-64:4.0.0'. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref.html | string | `aws/codebuild/docker:1.12.1` | no |
 | build_timeout | How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. | string | `60` | no |
@@ -146,6 +146,7 @@ Available targets:
 
 | Name | Description |
 |------|-------------|
+| badge_url | The URL of the build badge when badge_enabled is enabled |
 | cache_bucket_name | Cache S3 bucket name |
 | project_id | Project ID |
 | project_name | Project name |

diff --git a/docs/terraform.md b/docs/terraform.md
@@ -1,4 +1,3 @@
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -7,6 +6,7 @@
 | attributes | Additional attributes (e.g. `policy` or `role`) | list | `<list>` | no |
 | aws_account_id | (Optional) AWS Account ID. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `` | no |
 | aws_region | (Optional) AWS Region, e.g. us-east-1. Used as CodeBuild ENV variable when building Docker images. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html | string | `` | no |
+| badge_enabled | Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled. | string | `false` | no |
 | build_compute_type | Instance type of the build instance | string | `BUILD_GENERAL1_SMALL` | no |
 | build_image | Docker image for build environment, e.g. 'aws/codebuild/docker:1.12.1' or 'aws/codebuild/eb-nodejs-6.10.0-amazonlinux-64:4.0.0'. For more info: http://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref.html | string | `aws/codebuild/docker:1.12.1` | no |
 | build_timeout | How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. | string | `60` | no |
@@ -32,6 +32,7 @@
 
 | Name | Description |
 |------|-------------|
+| badge_url | The URL of the build badge when badge_enabled is enabled |
 | cache_bucket_name | Cache S3 bucket name |
 | project_id | Project ID |
 | project_name | Project name |

diff --git a/main.tf b/main.tf
@@ -161,6 +161,7 @@ resource "aws_codebuild_project" "default" {
   count         = "${var.enabled == "true" ? 1 : 0}"
   name          = "${module.label.id}"
   service_role  = "${aws_iam_role.default.arn}"
+  badge_enabled = "${var.badge_enabled}"
   build_timeout = "${var.build_timeout}"
 
   artifacts {

diff --git a/outputs.tf b/outputs.tf
@@ -17,3 +17,8 @@ output "cache_bucket_name" {
   description = "Cache S3 bucket name"
   value       = "${var.enabled == "true" && var.cache_enabled == "true" ? join("", aws_s3_bucket.cache_bucket.*.bucket) : "UNSET" }"
 }
+
+output "badge_url" {
+  description = "The URL of the build badge when badge_enabled is enabled"
+  value       = "${join("", aws_codebuild_project.default.*.badge_url)}"
+}
diff --git a/variables.tf b/variables.tf
@@ -51,6 +51,12 @@ variable "cache_bucket_suffix_enabled" {
   description = "The cache bucket generates a random 13 character string to generate a unique bucket name. If set to false it uses terraform-null-label's id value"
 }
 
+variable "badge_enabled" {
+  type        = "string"
+  default     = "false"
+  description = "Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled."
+}
+
 variable "build_image" {
   type        = "string"
   default     = "aws/codebuild/docker:1.12.1"