googleapis / googleapis/release-please

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

Open
#2,416 0 comments 0 reactions 1 assignee Claimed by @chingor13 View on GitHub
priority: p3 type: feature request
Dominant language
TypeScript
Stars
7.5k
Forks
588
Avg merge
12h 16m
Merged PRs (30d)
7

Description

**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](https://developer.hashicorp.com/terraform/language/modules/sources#selecting-a-revision):

```tf
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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.