terraform.star¶

Bump Terraform's required_version and provider version constraints.

Edits are line-based, so comments and alignment in .tf files stay as they were. .terraform.lock.hcl is not touched; run terraform init -upgrade in CI or a run step to refresh it.

load("@fleet//terraform.star", "files", "set_required_version", "set_provider_version")

Function	What it does
`files`	Lists the repo's Terraform files.
`set_required_version`	Sets every `required_version` constraint.
`set_provider_version`	Sets the version constraint of a provider in `required_providers`.

files¶

files(repo)

Lists the repo's Terraform files.

Arguments

Name	Description
`repo`	The repo passed to `change(repo)`.

Returns: The sorted paths of every .tf file outside .terraform directories.

Example

files(repo)
# returns ["main.tf", "modules/vpc/main.tf"]

Before

main.tf

terraform {}

modules/vpc/main.tf

terraform {}

.terraform/modules/x/main.tf

terraform {}

Source

set_required_version¶

set_required_version(repo, constraint)

Sets every required_version constraint.

A newer version already there is kept, so a campaign never lowers one.

Arguments

Name	Description
`repo`	The repo passed to `change(repo)`.
`constraint`	The new constraint, such as `>= 1.9`.

Returns: The list of paths that changed.

Example

set_required_version(repo, ">= 1.9")
# returns ["versions.tf"]

BeforeAfter

versions.tf

terraform {
  required_version = ">= 1.5"
}

versions.tf

terraform {
  required_version = ">= 1.9"
}

Used in: terraform-provider-bump

Source

set_provider_version¶

set_provider_version(repo, source, constraint)

Sets the version constraint of a provider in required_providers.

A newer version already there is kept, so a campaign never lowers one.

Works on entries written as a block or on one line (aws = { source = "hashicorp/aws", version = "~> 5.0" }), and on sources with the registry.terraform.io/ prefix. Entries without a version are left alone.

Arguments

Name	Description
`repo`	The repo passed to `change(repo)`.
`source`	The provider source, such as `hashicorp/aws`.
`constraint`	The new constraint, such as `~> 5.0`.

Returns: The list of paths that changed.

Example

set_provider_version(repo, "hashicorp/aws", "~> 5.0")
# returns ["versions.tf"]

BeforeAfter

versions.tf

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0" # pinned
    }
  }
}

versions.tf

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 5.0" # pinned
    }
  }
}

Used in: terraform-provider-bump

Source