terraform-docs-samples icon indicating copy to clipboard operation
terraform-docs-samples copied to clipboard

style: default values for `name` parameter in Cloud Run samples

Open rogerthatdev opened this issue 3 years ago • 2 comments

TL;DR

Currently, in Cloud Run samples, the google_cloud_run_service resource uses various generic values as the name, such ascloudrun-srv, cloud-run-service-name. For the sake of consistency, these names should be either meaningful to their intended function (example) or have a default generic value (something like my-cloud-run-service).

Terraform Resources

google_cloud_run_service

Detailed design

No response

Additional information

No response

rogerthatdev avatar Sep 15 '22 23:09 rogerthatdev

Since this issue was logged, the only samples that use generic names appear to be:

  • Tasks (being addressed in #568, incidentally)
  • run/traffic_* samples
  • run/*_tag_* samples

glasnt avatar Jan 16 '24 03:01 glasnt

Quick update: I was checking to know if this issues is still valid, and I found few areas to improve. So not closing this request.

noauth/main.tf:  name     = "cloudrun-srv"
..
remove_tag/main.tf:  name     = "cloudrun-srv"
secret_manager/main.tf:  name     = "cloudrun-srv-env-var-secret"
..
traffic_gradual_rollout/main.tf:  name     = "cloudrun-srv"
traffic_latest_revision/main.tf:  name     = "cloudrun-srv"
traffic_rollback/main.tf:  name     = "cloudrun-srv"
traffic_split/main.tf:  name     = "cloudrun-srv"
traffic_split_tag/main.tf:  name     = "cloudrun-srv"

msampathkumar avatar Sep 10 '24 10:09 msampathkumar