Fix muddle in the readme files, delete old files and helpers (not needed since #29)

Author: averbuks

Gemfile

@@ -18,7 +18,7 @@
 # Make will use bash instead of sh
 SHELL := /usr/bin/env bash
 
-DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.1.0
+DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.4.3
 DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
 REGISTRY_URL := gcr.io/cloud-foundation-cicd
 

Makefile

@@ -26,32 +26,36 @@ The
 is a tested reference of how to use the root module with the
 [event-project-log-entry submodule][event-project-log-entry-submodule].
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| available\_memory\_mb | The amount of memory in megabytes allotted for the function to use. | string | `"256"` | no |
+| available\_memory\_mb | The amount of memory in megabytes allotted for the function to use. | number | `"256"` | no |
+| bucket\_force\_destroy | When deleting the GCS bucket containing the cloud function, delete all objects in the bucket first. | bool | `"false"` | no |
+| bucket\_labels | A set of key/value label pairs to assign to the function source archive bucket. | map(string) | `<map>` | no |
+| bucket\_name | The name to apply to the bucket. Will default to a string of the function name. | string | `""` | no |
 | description | The description of the function. | string | `"Processes events."` | no |
 | entry\_point | The name of a method in the function source which will be invoked when the function is executed. | string | n/a | yes |
-| environment\_variables | A set of key/value environment variable pairs to assign to the function. | map | `<map>` | no |
-| event\_trigger | A source that fires events in response to a condition in another service. | map | n/a | yes |
-| labels | A set of key/value label pairs to assign to any lableable resources. | map | `<map>` | no |
+| environment\_variables | A set of key/value environment variable pairs to assign to the function. | map(string) | `<map>` | no |
+| event\_trigger | A source that fires events in response to a condition in another service. | map(string) | n/a | yes |
+| event\_trigger\_failure\_policy\_retry | A toggle to determine if the function should be retried on failure. | bool | `"false"` | no |
+| labels | A set of key/value label pairs to assign to the Cloud Function. | map(string) | `<map>` | no |
 | name | The name to apply to any nameable resources. | string | n/a | yes |
 | project\_id | The ID of the project to which resources will be applied. | string | n/a | yes |
 | region | The region in which resources will be applied. | string | n/a | yes |
-| runtime | The runtime in which the function will be executed. | string | `"nodejs6"` | no |
+| runtime | The runtime in which the function will be executed. | string | n/a | yes |
+| service\_account\_email | The service account to run the function as. | string | `""` | no |
 | source\_directory | The pathname of the directory which contains the function source code. | string | n/a | yes |
-| timeout\_s | The amount of time in seconds allotted for the execution of the function. | string | `"60"` | no |
+| timeout\_s | The amount of time in seconds allotted for the execution of the function. | number | `"60"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
 | name | The name of the function. |
 
-[^]: (autogen_docs_end)
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
 
@@ -63,11 +67,10 @@ order to invoke this module.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.12.Z
+- [Terraform][terraform-site] v0.12
 - [Terraform Provider for Archive][terraform-provider-archive-site]
-  v1.2.Z
-- [Terraform Provider for Google Cloud Platform][terraform-provider-gcp-site]
-  v2.5.Z
+  v1.2
+- [Terraform Provider for Google Cloud Platform][terraform-provider-gcp-site] v2.5
 
 ### IAM Roles
 
@@ -87,3 +90,15 @@ following APIs enabled:
 
 The [Project Factory module][project-factory-module-site] can be used to
 provision projects with specific APIs activated.
+
+## Contributing
+
+Refer to the [contribution guidelines](./CONTRIBUTING.md) for
+information on contributing to this module.
+
+[automatic-labelling-from-localhost-example]: examples/automatic-labelling-from-localhost
+[event-project-log-entry-submodule]: modules/event-project-log-entry
+[repository-function-submodule]: modules/repository-function
+[project-factory-module-site]: https://github.com/terraform-google-modules/terraform-google-project-factory/
+[terraform-provider-gcp-site]: https://github.com/terraform-providers/terraform-provider-google/
+[terraform-site]: https://www.terraform.io/

README.md

@@ -38,4 +38,4 @@ tags:
 - 'integration'
 substitutions:
   _DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
-  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.1.0'
+  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.4.3'

build/int.cloudbuild.yaml

@@ -21,4 +21,4 @@ tags:
 - 'lint'
 substitutions:
   _DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
-  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.1.0'
+  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.4.3'

build/lint.cloudbuild.yaml

@@ -25,6 +25,14 @@ this directory:
 | project\_id | The ID of the project to which resources will be applied. | string | n/a | yes |
 | region | The region in which resources will be applied. | string | n/a | yes |
 
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| project\_id | The ID of the project to which resources are applied. |
+| region | The region in which resources are applied. |
+| test\_project\_id | The ID of the project to test. |
+
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
@@ -40,7 +48,7 @@ must also be met.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.12.Z
+- [Terraform][terraform-site] v0.12
 
 ### IAM Roles
 

examples/automatic-labelling-folder/README.md

@@ -104,4 +104,4 @@ resource "google_project_iam_member" "test_project_iam" {
   project = google_project.test.project_id
   role    = "roles/owner"
   member  = "serviceAccount:${var.project_id}@appspot.gserviceaccount.com"
-}
+}

examples/automatic-labelling-folder/main.tf

@@ -17,8 +17,7 @@ this directory:
 - `terraform apply` to apply the execution plan
 - `terraform destroy` to destroy the infrastructure
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -27,7 +26,13 @@ this directory:
 | region | The region in which resources will be applied. | string | n/a | yes |
 | zone | The zone in which resources will be applied. | string | n/a | yes |
 
-[^]: (autogen_docs_end)
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| compute\_instance\_name | The name of the unlabelled Compute instance. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
 
@@ -42,7 +47,7 @@ must also be met.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.11.Z
+- [Terraform][terraform-site] v0.12
 
 ### IAM Roles
 

examples/automatic-labelling-from-localhost/README.md

@@ -9,16 +9,15 @@ principal email address of the account responsible for causing the events.
 
 ## Usage
 
-To provision this example, populate `terraform.tfvars` with the [required variables][#inputs] and run the following commands within
+To provision this example, populate `terraform.tfvars` with the [required variables][variables] and run the following commands within
 this directory:
 
 - `terraform init` to initialize the directory
 - `terraform plan` to generate the execution plan
 - `terraform apply` to apply the execution plan
 - `terraform destroy` to destroy the infrastructure
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -27,7 +26,13 @@ this directory:
 | region | The region in which resources will be applied. | string | n/a | yes |
 | zone | The zone in which resources will be applied. | string | n/a | yes |
 
-[^]: (autogen_docs_end)
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| compute\_instance\_name | The name of the unlabelled Compute instance. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
 
@@ -43,7 +48,7 @@ must also be met.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.11.Z
+- [Terraform][terraform-site] v0.12
 
 ### IAM Roles
 
@@ -65,3 +70,5 @@ following APIs enabled:
 [event-project-log-entry-submodule]: ../../modules/event-project-log-entry
 [repository-function-submodule-requirements]: ../../modules/repository-function/README.md#requirements
 [repository-function-submodule]: ../../modules/repository-function
+[terraform-site]: https://terraform.io/
+[variables]: ./variables.tf

examples/automatic-labelling-from-repository/README.md

@@ -8,24 +8,23 @@ which responds to Compute VM creation events by deleting any VM instances create
 
 ## Usage
 
-To provision this example, populate `terraform.tfvars` with the [required variables](#inputs) and run the following commands within
+To provision this example, populate `terraform.tfvars` with the [required variables][variables] and run the following commands within
 this directory:
 
 - `terraform init` to initialize the directory
 - `terraform plan` to generate the execution plan
 - `terraform apply` to apply the execution plan
 - `terraform destroy` to destroy the infrastructure
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
 | project\_id | The ID of the project to which resources will be applied. | string | n/a | yes |
 | region | The region in which resources will be applied. | string | n/a | yes |
 
-[^]: (autogen_docs_end)
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
 
@@ -40,7 +39,7 @@ must also be met.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.11.Z
+- [Terraform][terraform-site] v0.12
 
 ### IAM Roles
 
@@ -64,3 +63,4 @@ following APIs enabled:
 [root-module-requirements]: ../../README.md#requirements
 [root-module]: ../..
 [terraform-site]: https://terraform.io/
+[variables]: ./variables.tf