Skip to content

Commit

Permalink
[BE] Improve documentation of somewhat ambiguous terraform variables (#…
Browse files Browse the repository at this point in the history
…5286)

These are used to configure the system that provisions runners. Update
the documentation to capture the nuances of the parameters here
  • Loading branch information
ZainRizvi authored Jun 6, 2024
1 parent 4373436 commit 20eabd8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions terraform-aws-github-runner/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -343,13 +343,13 @@ variable "cant_have_issues_labels" {
}

variable "scale_config_repo" {
description = "Repository to fetch scale config from."
default = ""
description = "Repository to fetch scale config from if `enable_organization_runners` is set to true. Otherwise the job's repo will be used"
default = "" # Internally defaults to 'test-infra'
type = string
}

variable "scale_config_repo_path" {
description = "Path in the repository to fetch scale config from."
default = ""
description = "Path relative to repo root the scale config should be fetched from. If `enable_organization_runners` is set to false, will be relative to the job's repo root instaed. If `enable_organization_runners` is set to true, will be relative to `scale_config_repo`."
default = "" # Internally defaults to '.github/scale-config.yml'
type = string
}

0 comments on commit 20eabd8

Please sign in to comment.