README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-codebuild

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - cicd
  - codepipeline
  - codebuild
  - continuous-integration
  - continuous-delivery

# Categories of this project
categories:
  - terraform-modules/cicd

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-codebuild

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-codebuild.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-codebuild"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-codebuild.svg"
    url: "https://github.com/cloudposse/terraform-aws-codebuild/releases"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-ecs-codepipeline"
    description: "Terraform Module for CI/CD with AWS Code Pipeline and Code Build for ECS"
    url: "https://github.com/cloudposse/terraform-aws-ecs-codepipeline"

# Short description of this project
description: |-
  Terraform module to create AWS CodeBuild project for AWS CodePipeline.

# How to use this project
usage: |-
  Include this module in your existing terraform code:

  ```hcl
  module "build" {
      source              = "git::https://github.com/cloudposse/terraform-aws-codebuild.git?ref=master"
      namespace           = "general"
      name                = "ci"
      stage               = "staging"

      # https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
      build_image         = "aws/codebuild/docker:1.12.1"
      build_compute_type  = "BUILD_GENERAL1_SMALL"
      build_timeout       = "60"

      # These attributes are optional, used as ENV variables when building Docker images and pushing them to ECR
      # For more info:
      # http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html
      # https://www.terraform.io/docs/providers/aws/r/codebuild_project.html

      privileged_mode     = "true"
      aws_region          = "us-east-1"
      aws_account_id      = "xxxxxxxxxx"
      image_repo_name     = "ecr-repo-name"
      image_tag           = "latest"

      # Optional extra environment variables
      environment_variables = [{
          name  = "JENKINS_URL"
          value = "https://jenkins.example.com"
        },
        {
          name  = "COMPANY_NAME"
          value = "Amazon"
        },
        {
          name = "TIME_ZONE"
          value = "Pacific/Auckland"

        }]
  }
  ```

  ### To hide warnings about unset versions in providers

  Add this to your .tf files
  ```hcl
  provider "random" {
    version = "~> 1.0"
  }

  provider "null" {
    version = "~> 1.0"
  }
  ```

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Jamie Nelson"
    github: "Jamie-BitfFlight"
  - name: "Sarkis Varozian"
    github: "sarkis"