fix: Recursively update version in Terraform submodule READMEs.

Author: morgante

__snapshots__/terraform-module.js

@@ -11,7 +11,7 @@ filename: CHANGELOG.md
 * **deps:** update dependency com.google.cloud:google-cloud-spanner to v1.50.0 ([1f9663c](https://www.github.com/googleapis/terraform-test-repo/commit/1f9663cf08ab1cf3b68d95dee4dc99b7c4aac373))
 * **deps:** update dependency com.google.cloud:google-cloud-storage to v1.120.0 ([fcd1c89](https://www.github.com/googleapis/terraform-test-repo/commit/fcd1c890dc1526f4d62ceedad561f498195c8939))
 
-filename: README.md
+filename: readme.md
 # Terraform Module
 
 ## Usage
@@ -83,6 +83,30 @@ module "vpc" {
 }
 \`\`\`
 
+filename: module-submodule/modules/sub-module-with-version/readme.md
+# Terraform Module
+
+## Usage
+
+\`\`\`hcl
+module "vpc" {
+    source  = "terraform-google-modules/mine/google"
+    version = "~> 2.1"
+}
+\`\`\`
+
+filename: module-submodule/modules/sub-module-missing-versions/README.md
+# Terraform Module
+
+## Usage
+
+\`\`\`hcl
+module "vpc" {
+    source  = "terraform-google-modules/mine/google"
+    version = "~> 2.1"
+}
+\`\`\`
+
 filename: versions.tf
 /**
  * Copyright 2020 Google LLC
@@ -164,7 +188,7 @@ filename: CHANGELOG.md
 * **deps:** update dependency com.google.cloud:google-cloud-spanner to v1.50.0 ([1f9663c](https://www.github.com/googleapis/terraform-test-repo/commit/1f9663cf08ab1cf3b68d95dee4dc99b7c4aac373))
 * **deps:** update dependency com.google.cloud:google-cloud-storage to v1.120.0 ([fcd1c89](https://www.github.com/googleapis/terraform-test-repo/commit/fcd1c890dc1526f4d62ceedad561f498195c8939))
 
-filename: README.md
+filename: module-no-versions/README.MD
 # Terraform Module
 
 ## Usage

src/releasers/terraform-module.ts

@@ -78,14 +78,20 @@ export class TerraformModule extends ReleasePR {
       })
     );
 
-    updates.push(
-      new ReadMe({
-        path: this.addPath('README.md'),
-        changelogEntry,
-        version: candidate.version,
-        packageName: this.packageName,
-      })
-    );
+    // Update version in README to current candidate version.
+    // A module may have submodules, so find all submodules.
+    const readmeFiles = await this.gh.findFilesByFilename('readme.md');
+    readmeFiles.forEach(path => {
+      updates.push(
+        new ReadMe({
+          path: this.addPath(path),
+          changelogEntry,
+          version: candidate.version,
+          packageName: this.packageName,
+        })
+      );
+    });
+
     // Update versions.tf to current candidate version.
     // A module may have submodules, so find all versions.tf to update.
     const versionFiles = await this.gh.findFilesByFilename('versions.tf');

test/releasers/fixtures/terraform/module-submodule/modules/sub-module-with-version/versions.tf

@@ -22,10 +22,10 @@ terraform {
   }
 
   provider_meta "google" {
-    module_name = "foo/bar/submodule/v1.0.0"
+    module_name = "foo/bar/submodule/v2.0.0"
   }
 
   provider_meta "google-beta" {
-    module_name = "foo/bar/submodule/v1.0.0"
+    module_name = "foo/bar/submodule/v2.0.0"
   }
 }

test/releasers/fixtures/terraform/module-submodule/versions.tf

@@ -22,10 +22,10 @@ terraform {
   }
 
   provider_meta "google" {
-    module_name = "foo/bar/main/v1.0.0"
+    module_name = "foo/bar/main/v2.0.0"
   }
 
   provider_meta "google-beta" {
-    module_name = "foo/bar/main/v1.0.0"
+    module_name = "foo/bar/main/v2.0.0"
   }
 }

test/releasers/fixtures/terraform/simple-module/versions.tf

@@ -22,10 +22,10 @@ terraform {
   }
 
   provider_meta "google" {
-    module_name = "foo/bar/baz/v1.0.0"
+    module_name = "foo/bar/baz/v2.0.0"
   }
 
   provider_meta "google-beta" {
-    module_name = "foo/bar/baz/v1.0.0"
+    module_name = "foo/bar/baz/v2.0.0"
   }
 }

test/releasers/terraform-module.ts

@@ -39,6 +39,7 @@ describe('terraform-module', () => {
       // simple-module with module versions defined
       name: 'simple-module',
       findVersionFiles: ['versions.tf'],
+      findReadmeFiles: ['readme.md'],
       readFilePaths: ['simple-module/readme.md', 'simple-module/versions.tf'],
     },
     {
@@ -50,8 +51,15 @@ describe('terraform-module', () => {
         'versions.tf',
         'modules/sub-module-with-version/versions.tf',
       ],
+      findReadmeFiles: [
+        'README.md',
+        'module-submodule/modules/sub-module-with-version/readme.md',
+        'module-submodule/modules/sub-module-missing-versions/README.md',
+      ],
       readFilePaths: [
-        'module-submodule/readme.md',
+        'module-submodule/README.md',
+        'module-submodule/modules/sub-module-with-version/readme.md',
+        'module-submodule/modules/sub-module-missing-versions/README.md',
         'module-submodule/versions.tf',
         'module-submodule/modules/sub-module-with-version/versions.tf',
       ],
@@ -60,6 +68,7 @@ describe('terraform-module', () => {
       // module-no-versions with no module versions defined in versions.tf
       name: 'module-no-versions',
       findVersionFiles: [],
+      findReadmeFiles: ['module-no-versions/README.MD'],
       readFilePaths: ['module-no-versions/readme.md'],
     },
   ];
@@ -91,6 +100,9 @@ describe('terraform-module', () => {
       it(`creates a release PR for ${test.name}`, async () => {
         sandbox
           .stub(releasePR.gh, 'findFilesByFilename')
+          .onFirstCall()
+          .returns(Promise.resolve(test.findReadmeFiles))
+          .onSecondCall()
           .returns(Promise.resolve(test.findVersionFiles));
 
         // Return latest tag used to determine next version #: