added option to configure path to go.work

Author: spacecowboy

__snapshots__/go-workspace.js

@@ -73,6 +73,49 @@ Release notes for path: packages/goB, releaseType: go
 This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
 `
 
+exports['GoWorkspace plugin run uses go-work-file config value 1'] = `
+:robot: I have created a release *beep* *boop*
+---
+
+
+<details><summary>example.com/packages/goA: 1.1.2</summary>
+
+Release notes for path: packages/goA, releaseType: go
+</details>
+
+<details><summary>example.com/packages/goB/v2: 2.2.3</summary>
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * example.com/packages/goA bumped from 1.1.1 to 1.1.2
+</details>
+
+<details><summary>example.com/packages/goC: 3.3.4</summary>
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * example.com/packages/goB/v2 bumped from 2.2.2 to 2.2.3
+</details>
+
+<details><summary>example.com/packages/goD: 4.4.5</summary>
+
+Release notes for path: packages/goD, releaseType: go
+</details>
+
+<details><summary>example.com/packages/goE: 3.3.4</summary>
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * example.com/packages/goA bumped from 1.1.1 to 1.1.2
+</details>
+
+---
+This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
+`
+
 exports['GoWorkspace plugin run walks dependency tree and updates previously untouched packages 1'] = `
 :robot: I have created a release *beep* *boop*
 ---

docs/manifest-releaser.md

@@ -542,6 +542,22 @@ all modules in a workspace and updates any modules that depends
 (directly or transitively) on the changed module. The workspace dependencies in
 `go.mod` files are updated accordingly.
 
+#### go.work in a non-default location
+
+By default, the `go.work` file is expected to be in the root. Set `"goWorkFile"`
+to a custom path to use a file in a different location.
+
+```
+{
+  "plugins": [
+    {
+      "type": "go-workspace",
+      "goWorkFile": "/path/to/filename"
+    }
+  ]
+}
+```
+
 ### maven-workspace
 
 The `maven-workspace` plugin operates similarly to the `node-workspace` plugin,

schemas/config.json

@@ -367,6 +367,10 @@
                   "updatePeerDependencies": {
                     "description": "Also bump peer dependency versions if they are modified. Defaults to `false`.",
                     "type": "boolean"
+                  },
+                  "goWorkFile": {
+                    "description": "Path to the go.work file. Defaults to `go.work`.",
+                    "type": "string"
                   }
                 }
               },

src/factories/plugin-factory.ts

@@ -49,6 +49,9 @@ export interface PluginFactoryOptions {
   updateAllPackages?: boolean;
   considerAllArtifacts?: boolean;
 
+  // go options
+  goWorkFile?: string;
+
   logger?: Logger;
 }
 

src/manifest.ts

@@ -234,6 +234,9 @@ export interface WorkspacePluginConfig extends ConfigurablePluginType {
 export interface NodeWorkspacePluginConfig extends WorkspacePluginConfig {
   updatePeerDependencies?: boolean;
 }
+export interface GoWorkspacePluginConfig extends WorkspacePluginConfig {
+  goWorkFile?: string;
+}
 export interface GroupPriorityPluginConfig extends ConfigurablePluginType {
   groups: string[];
 }
@@ -244,7 +247,8 @@ export type PluginType =
   | LinkedVersionPluginConfig
   | SentenceCasePluginConfig
   | WorkspacePluginConfig
-  | NodeWorkspacePluginConfig;
+  | NodeWorkspacePluginConfig
+  | GoWorkspacePluginConfig;
 
 /**
  * This is the schema of the manifest config json
@@ -332,6 +336,7 @@ export class Manifest {
    *   plugin
    * @param {boolean} manifestOptions.updatePeerDependencies Option for the node-workspace
    *   plugin
+   * @param {string} manifestOptions.goWorkFile Option for the go-workspace plugin
    * @param {boolean} manifestOptions.separatePullRequests If true, create separate pull
    *   requests instead of a single manifest release pull request
    * @param {PluginType[]} manifestOptions.plugins Any plugins to use for this repository
@@ -450,6 +455,7 @@ export class Manifest {
    *   plugin
    * @param {boolean} manifestOptions.updatePeerDependencies Option for the node-workspace
    *   plugin
+   * @param {string} manifestOptions.goWorkFile Option for the go-workspace plugin
    * @param {boolean} manifestOptions.separatePullRequests If true, create separate pull
    *   requests instead of a single manifest release pull request
    * @param {PluginType[]} manifestOptions.plugins Any plugins to use for this repository

src/plugins/go-workspace.ts

@@ -67,6 +67,10 @@ interface GoModInfo {
   modContent: string;
 }
 
+interface GoWorkspaceOptions extends WorkspacePluginOptions {
+  goWorkFile?: string;
+}
+
 /**
  * The plugin analyzes a go workspace and will bump dependencies
  * of managed packages if those dependencies are being updated.
@@ -78,16 +82,18 @@ export class GoWorkspace extends WorkspacePlugin<GoModInfo> {
   private strategiesByPath: Record<string, Strategy> = {};
   private releasesByPath: Record<string, Release> = {};
   private readonly releaseManifestPath: string;
+  private readonly goWorkPath: string;
 
   constructor(
     github: GitHub,
     targetBranch: string,
     repositoryConfig: RepositoryConfig,
-    options: WorkspacePluginOptions = {}
+    options: GoWorkspaceOptions = {}
   ) {
     super(github, targetBranch, repositoryConfig, options);
     this.releaseManifestPath =
       options.manifestPath ?? DEFAULT_RELEASE_PLEASE_MANIFEST;
+    this.goWorkPath = options.goWorkFile || 'go.work';
   }
 
   protected bumpVersion(pkg: GoModInfo): Version {
@@ -256,14 +262,12 @@ export class GoWorkspace extends WorkspacePlugin<GoModInfo> {
     candidatesByPackage: Record<string, CandidateReleasePullRequest>;
   }> {
     const goWorkspaceContent = await this.github.getFileContentsOnBranch(
-      'go.work',
+      this.goWorkPath,
       this.targetBranch
     );
     const goWorkspace = parseGoWorkspace(goWorkspaceContent.parsedContent);
     if (!goWorkspace?.members) {
-      this.logger.warn(
-        "go-workspace plugin used, but could not find use directive(s) 'go.work' file"
-      );
+      this.logger.warn('go-workspace plugin used, but found no use directives');
       return {allPackages: [], candidatesByPackage: {}};
     }
 

test/plugins/go-workspace.ts

@@ -342,5 +342,103 @@ describe('GoWorkspace plugin', () => {
       assertHasUpdate(updates, 'packages/goB/go.mod', RawContent);
       snapshot(dateSafe(goCandidate!.pullRequest.body.toString()));
     });
+    it('uses go-work-file config value', async () => {
+      const options = {goWorkFile: 'some/go.work.file'};
+      plugin = new GoWorkspace(
+        github,
+        'main',
+        {
+          'packages/goA': {
+            releaseType: 'go',
+          },
+          'packages/goB': {
+            releaseType: 'go',
+          },
+          'packages/goC': {
+            releaseType: 'go',
+          },
+          'packages/goD': {
+            releaseType: 'go',
+          },
+        },
+        options
+      );
+
+      const candidates: CandidateReleasePullRequest[] = [
+        buildMockCandidatePullRequest('packages/goA', 'go', '1.1.2', {
+          component: 'example.com/packages/goA',
+          updates: [
+            buildMockPackageUpdate(
+              'packages/goA/go.mod',
+              'packages/goA/go.mod',
+              '1.1.1'
+            ),
+          ],
+        }),
+        buildMockCandidatePullRequest('packages/goD', 'go', '4.4.5', {
+          component: 'example.com/packages/goD',
+          updates: [
+            buildMockPackageUpdate(
+              'packages/goD/go.mod',
+              'packages/goD/go.mod',
+              '4.4.4'
+            ),
+          ],
+        }),
+      ];
+
+      stubFilesFromFixtures({
+        sandbox,
+        github,
+        fixturePath: fixturesPath,
+        files: [
+          '.release-please-manifest.json',
+          'packages/goA/go.mod',
+          'packages/goA/CHANGELOG.md',
+          'packages/goB/go.mod',
+          'packages/goB/CHANGELOG.md',
+          'packages/goC/go.mod',
+          'packages/goC/CHANGELOG.md',
+          'packages/goD/go.mod',
+          'packages/goD/CHANGELOG.md',
+          'packages/goE/go.mod',
+          'packages/goE/CHANGELOG.md',
+        ],
+        inlineFiles: [
+          [
+            'some/go.work.file',
+            'go 1.23.1\nuse ./packages/goA\n\nuse ./packages/goB\nuse ./packages/goC\nuse ./packages/goD\nuse ./packages/goE\n',
+          ],
+        ],
+        flatten: false,
+        targetBranch: 'main',
+      });
+      sandbox
+        .stub(github, 'findFilesByGlobAndRef')
+        .withArgs('packages/goA', 'main')
+        .resolves(['packages/goA'])
+        .withArgs('packages/goB', 'main')
+        .resolves(['packages/goB'])
+        .withArgs('packages/goC', 'main')
+        .resolves(['packages/goC'])
+        .withArgs('packages/goD', 'main')
+        .resolves(['packages/goD'])
+        .withArgs('packages/goE', 'main')
+        .resolves(['packages/goE']);
+      const newCandidates = await plugin.run(candidates);
+      expect(newCandidates).lengthOf(1);
+      const goCandidate = newCandidates.find(
+        candidate => candidate.config.releaseType === 'go'
+      );
+      expect(goCandidate).to.not.be.undefined;
+      const updates = goCandidate!.pullRequest.updates;
+      // Check that transitive dependencies are updated
+      assertHasUpdate(updates, 'packages/goA/go.mod', RawContent);
+      assertHasUpdate(updates, 'packages/goB/go.mod', RawContent);
+      assertHasUpdate(updates, 'packages/goC/go.mod', RawContent);
+      assertHasUpdate(updates, 'packages/goD/go.mod', RawContent);
+      assertHasUpdate(updates, 'packages/goE/go.mod', RawContent);
+      snapshot(dateSafe(goCandidate!.pullRequest.body.toString()));
+    });
   });
 });