terraform-module readme updater does not replace git-styled refs

[d-costa]

Is your feature request related to a problem? Please describe.

terraform-module release type does not replace version in READMEs that use git-styled references:

module "vpc" {
  source = "git::https://example.com/vpc.git?ref=v1.2.0"
}

Describe the solution you'd like

• Add the ability for the README updater to replace such versions, for example:

ref=v[\d]+.[\d]+.[\d]+

ref=v${this.version.major}.${this.version.minor}.${this.version.patch}

Describe alternatives you've considered

• Run a workflow on release please PRs to add a commit replacing all ref=[\d]+.[\d]+.[\d]+ occurrences.

Additional context

• Our team has some GitHub repositories with multiple modules. Would it be possible to run the updater recursively?

Example structure:

• module-a
  • main.tf
  • README.md
• module-b
  • main.tf
  • outputs.tf
  • README.md