Skip to content

Commit e9695c1

Browse files
jamengualPePe (Jose) Amengualosterman
authored
Updating modules dependencies, to add the fix for github provider (#33)
* Updating modules dependencies, to add the fix for github provider and others * Update main.tf * Upgrading to latest github webhook module * fixing cache bucket missing due to upstream change * fixing cache bucket missing due to upstream change * fixing cache bucket missing due to upstream change * fixing cache bucket missing due to upstream change * Adding cache_type variable * updaing docs * fixing the docs Co-authored-by: PePe (Jose) Amengual <[email protected]> Co-authored-by: Erik Osterman <[email protected]>
1 parent 569ee2a commit e9695c1

File tree

5 files changed

+140
-93
lines changed

5 files changed

+140
-93
lines changed

‎README.md

+65-46
Original file line numberDiff line numberDiff line change
@@ -189,60 +189,79 @@ Available targets:
189189
help/short This help short screen
190190

191191
```
192+
## Requirements
193+
194+
| Name | Version |
195+
|------|---------|
196+
| terraform | ~> 0.12.0 |
197+
| aws | ~> 2.0 |
198+
| local | ~> 1.2 |
199+
| null | ~> 2.0 |
200+
| random | ~> 2.1 |
201+
| template | ~> 2.0 |
202+
203+
## Providers
204+
205+
| Name | Version |
206+
|------|---------|
207+
| aws | ~> 2.0 |
208+
| random | ~> 2.1 |
209+
192210
## Inputs
193211
194212
| Name | Description | Type | Default | Required |
195-
|------|-------------|:----:|:-----:|:-----:|
196-
| attributes | Additional attributes (_e.g._ "1") | list(string) | `<list>` | no |
197-
| aws_account_id | 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 |
198-
| badge_enabled | Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled | bool | `false` | no |
199-
| branch | Branch of the GitHub repository, _e.g._ `master` | string | - | yes |
200-
| build_compute_type | `CodeBuild` instance size. Possible values are: `BUILD_GENERAL1_SMALL` `BUILD_GENERAL1_MEDIUM` `BUILD_GENERAL1_LARGE` | string | `BUILD_GENERAL1_SMALL` | no |
201-
| build_image | Docker image for build environment, _e.g._ `aws/codebuild/docker:docker:17.09.0` | string | `aws/codebuild/docker:17.09.0` | no |
202-
| 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 | number | `60` | no |
203-
| buildspec | Declaration to use for building the project. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) | string | `` | no |
204-
| delimiter | Delimiter between `namespace`, `stage`, `name` and `attributes` | string | `-` | no |
205-
| ecs_cluster_name | ECS Cluster Name | string | - | yes |
206-
| enabled | Enable `CodePipeline` creation | bool | `true` | no |
207-
| environment_variables | A list of maps, that contain both the key 'name' and the key 'value' to be used as additional environment variables for the build | object | `<list>` | no |
208-
| github_oauth_token | GitHub OAuth Token with permissions to access private repositories | string | - | yes |
209-
| github_webhook_events | A list of events which should trigger the webhook. See a list of [available events](https://developer.github.com/v3/activity/events/types/) | list(string) | `<list>` | no |
210-
| github_webhooks_token | GitHub OAuth Token with permissions to create webhooks. If not provided, can be sourced from the `GITHUB_TOKEN` environment variable | string | `` | no |
211-
| image_repo_name | ECR repository name to store the Docker image built by this module. Used as CodeBuild ENV variable when building Docker images. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html) | string | - | yes |
212-
| image_tag | Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable when building Docker images. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html) | string | `latest` | no |
213-
| name | Name of the application | string | - | yes |
214-
| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no |
215-
| poll_source_changes | Periodically check the location of your source content and run the pipeline if changes are detected | bool | `false` | no |
216-
| privileged_mode | If set to true, enables running the Docker daemon inside a Docker container on the CodeBuild instance. Used when building Docker images | bool | `false` | no |
217-
| region | 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 | - | yes |
218-
| repo_name | GitHub repository name of the application to be built and deployed to ECS | string | - | yes |
219-
| repo_owner | GitHub Organization or Username | string | - | yes |
220-
| s3_bucket_force_destroy | A boolean that indicates all objects should be deleted from the CodePipeline artifact store S3 bucket so that the bucket can be destroyed without error | bool | `false` | no |
221-
| service_name | ECS Service Name | string | - | yes |
222-
| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | `` | no |
223-
| tags | Additional tags (_e.g._ { BusinessUnit : ABC }) | map(string) | `<map>` | no |
224-
| webhook_authentication | The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED | string | `GITHUB_HMAC` | no |
225-
| webhook_enabled | Set to false to prevent the module from creating any webhook resources | bool | `true` | no |
226-
| webhook_filter_json_path | The JSON path to filter on | string | `$.ref` | no |
227-
| webhook_filter_match_equals | The value to match on (e.g. refs/heads/{Branch}) | string | `refs/heads/{Branch}` | no |
228-
| webhook_target_action | The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline | string | `Source` | no |
213+
|------|-------------|------|---------|:--------:|
214+
| attributes | Additional attributes (\_e.g.\_ "1") | `list(string)` | `[]` | no |
215+
| aws\_account\_id | 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 |
216+
| badge\_enabled | Generates a publicly-accessible URL for the projects build badge. Available as badge\_url attribute when enabled | `bool` | `false` | no |
217+
| branch | Branch of the GitHub repository, _e.g._ `master` | `string` | n/a | yes |
218+
| build\_compute\_type | `CodeBuild` instance size. Possible values are: `BUILD_GENERAL1_SMALL` `BUILD_GENERAL1_MEDIUM` `BUILD_GENERAL1_LARGE` | `string` | `"BUILD_GENERAL1_SMALL"` | no |
219+
| build\_image | Docker image for build environment, _e.g._ `aws/codebuild/docker:docker:17.09.0` | `string` | `"aws/codebuild/docker:17.09.0"` | no |
220+
| 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 | `number` | `60` | no |
221+
| buildspec | Declaration to use for building the project. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) | `string` | `""` | no |
222+
| cache\_type | The type of storage that will be used for the AWS CodeBuild project cache. Valid values: NO\_CACHE, LOCAL, and S3. Defaults to S3. If cache\_type is S3, it will create an S3 bucket for storing codebuild cache inside | `string` | `"S3"` | no |
223+
| delimiter | Delimiter between `namespace`, `stage`, `name` and `attributes` | `string` | `"-"` | no |
224+
| ecs\_cluster\_name | ECS Cluster Name | `string` | n/a | yes |
225+
| enabled | Enable `CodePipeline` creation | `bool` | `true` | no |
226+
| environment\_variables | A list of maps, that contain both the key 'name' and the key 'value' to be used as additional environment variables for the build | <pre>list(object(<br> {<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
227+
| github\_oauth\_token | GitHub OAuth Token with permissions to access private repositories | `string` | n/a | yes |
228+
| github\_webhook\_events | A list of events which should trigger the webhook. See a list of [available events](https://developer.github.com/v3/activity/events/types/) | `list(string)` | <pre>[<br> "push"<br>]</pre> | no |
229+
| github\_webhooks\_token | GitHub OAuth Token with permissions to create webhooks. If not provided, can be sourced from the `GITHUB_TOKEN` environment variable | `string` | `""` | no |
230+
| image\_repo\_name | ECR repository name to store the Docker image built by this module. Used as CodeBuild ENV variable when building Docker images. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html) | `string` | n/a | yes |
231+
| image\_tag | Docker image tag in the ECR repository, e.g. 'latest'. Used as CodeBuild ENV variable when building Docker images. [For more info](http://docs.aws.amazon.com/codebuild/latest/userguide/sample-docker.html) | `string` | `"latest"` | no |
232+
| name | Name of the application | `string` | n/a | yes |
233+
| namespace | Namespace (e.g. `eg` or `cp`) | `string` | `""` | no |
234+
| poll\_source\_changes | Periodically check the location of your source content and run the pipeline if changes are detected | `bool` | `false` | no |
235+
| privileged\_mode | If set to true, enables running the Docker daemon inside a Docker container on the CodeBuild instance. Used when building Docker images | `bool` | `false` | no |
236+
| region | 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` | n/a | yes |
237+
| repo\_name | GitHub repository name of the application to be built and deployed to ECS | `string` | n/a | yes |
238+
| repo\_owner | GitHub Organization or Username | `string` | n/a | yes |
239+
| s3\_bucket\_force\_destroy | A boolean that indicates all objects should be deleted from the CodePipeline artifact store S3 bucket so that the bucket can be destroyed without error | `bool` | `false` | no |
240+
| service\_name | ECS Service Name | `string` | n/a | yes |
241+
| stage | Stage (e.g. `prod`, `dev`, `staging`) | `string` | `""` | no |
242+
| tags | Additional tags (\_e.g.\_ { BusinessUnit : ABC }) | `map(string)` | `{}` | no |
243+
| webhook\_authentication | The type of authentication to use. One of IP, GITHUB\_HMAC, or UNAUTHENTICATED | `string` | `"GITHUB_HMAC"` | no |
244+
| webhook\_enabled | Set to false to prevent the module from creating any webhook resources | `bool` | `true` | no |
245+
| webhook\_filter\_json\_path | The JSON path to filter on | `string` | `"$.ref"` | no |
246+
| webhook\_filter\_match\_equals | The value to match on (e.g. refs/heads/{Branch}) | `string` | `"refs/heads/{Branch}"` | no |
247+
| webhook\_target\_action | The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline | `string` | `"Source"` | no |
229248

230249
## Outputs
231250

232251
| Name | Description |
233252
|------|-------------|
234-
| badge_url | The URL of the build badge when badge_enabled is enabled |
235-
| codebuild_badge_url | The URL of the build badge when badge_enabled is enabled |
236-
| codebuild_cache_bucket_arn | CodeBuild cache S3 bucket ARN |
237-
| codebuild_cache_bucket_name | CodeBuild cache S3 bucket name |
238-
| codebuild_project_id | CodeBuild project ID |
239-
| codebuild_project_name | CodeBuild project name |
240-
| codebuild_role_arn | CodeBuild IAM Role ARN |
241-
| codebuild_role_id | CodeBuild IAM Role ID |
242-
| codepipeline_arn | CodePipeline ARN |
243-
| codepipeline_id | CodePipeline ID |
244-
| webhook_id | The CodePipeline webhook's ID |
245-
| webhook_url | The CodePipeline webhook's URL. POST events to this endpoint to trigger the target |
253+
| badge\_url | The URL of the build badge when badge\_enabled is enabled |
254+
| codebuild\_badge\_url | The URL of the build badge when badge\_enabled is enabled |
255+
| codebuild\_cache\_bucket\_arn | CodeBuild cache S3 bucket ARN |
256+
| codebuild\_cache\_bucket\_name | CodeBuild cache S3 bucket name |
257+
| codebuild\_project\_id | CodeBuild project ID |
258+
| codebuild\_project\_name | CodeBuild project name |
259+
| codebuild\_role\_arn | CodeBuild IAM Role ARN |
260+
| codebuild\_role\_id | CodeBuild IAM Role ID |
261+
| codepipeline\_arn | CodePipeline ARN |
262+
| codepipeline\_id | CodePipeline ID |
263+
| webhook\_id | The CodePipeline webhook's ID |
264+
| webhook\_url | The CodePipeline webhook's URL. POST events to this endpoint to trigger the target |
246265

247266

248267

0 commit comments

Comments
 (0)