updates (#175)

meorphis · web-flow · commit b40c6fe4d0ad · 2024-10-01T15:00:46.000Z
diff --git a/src/strategies/go-yoshi.ts b/src/strategies/go-yoshi.ts
@@ -71,12 +71,18 @@ export class GoYoshi extends BaseStrategy {
       }),
     });
 
-    const allFiles = await this.github.findFilesByGlobAndRef(
+    const goFiles = await this.github.findFilesByGlobAndRef(
       '**/*.go',
       this.changesBranch
     );
 
-    for (const file of allFiles) {
+    // handle code snippets in markdown files as well
+    const mdFiles = await this.github.findFilesByGlobAndRef(
+      '**/*.md',
+      this.changesBranch
+    );
+
+    for (const file of [...goFiles, ...mdFiles]) {
       updates.push({
         path: this.addPath(file),
         createIfMissing: false,
diff --git a/src/strategies/go.ts b/src/strategies/go.ts
@@ -34,12 +34,18 @@ export class Go extends BaseStrategy {
       }),
     });
 
-    const allFiles = await this.github.findFilesByGlobAndRef(
+    const goFiles = await this.github.findFilesByGlobAndRef(
       '**/*.go',
       this.changesBranch
     );
 
-    for (const file of allFiles) {
+    // handle code snippets in markdown files as well
+    const mdFiles = await this.github.findFilesByGlobAndRef(
+      '**/*.md',
+      this.changesBranch
+    );
+
+    for (const file of [...goFiles, ...mdFiles]) {
       updates.push({
         path: this.addPath(file),
         createIfMissing: true,
diff --git a/src/updaters/go/github-imports-go.ts b/src/updaters/go/github-imports-go.ts
@@ -7,9 +7,11 @@ export class GithubImportsGo extends DefaultUpdater {
     }
 
     return content.replace(
-      /"github\.com\/([^/]+)\/([^/]+)(\/v([1-9]\d*))?\/(.+)"/g,
-      (_, user, repo, __, ___, path) =>
-        `"github.com/${user}/${repo}/v${this.version.major.toString()}/${path}"`
+      /"(https:\/\/pkg.go.dev\/)?github\.com\/([^/]+)\/([^/]+)(\/v([1-9]\d*))?(\/[^"]+)?"/g,
+      (_, prefix, user, repo, ___, ____, path) =>
+        `"${prefix ?? ''}github.com/${user}/${repo}${
+          this.version.major < 2 ? '' : '/v' + this.version.major.toString()
+        }${path ?? ''}"`
     );
   }
 }
diff --git a/test/strategies/go-yoshi.ts b/test/strategies/go-yoshi.ts
@@ -47,7 +47,10 @@ describe('GoYoshi', () => {
 
     sandbox
       .stub(github, 'findFilesByGlobAndRef')
-      .resolves(['file-with-imports-v2.go']);
+      .withArgs('**/*.go', 'main')
+      .resolves(['file-with-imports-v2.go'])
+      .withArgs('**/*.md', 'main')
+      .resolves([]);
   });
   afterEach(() => {
     sandbox.restore();
diff --git a/test/strategies/go.ts b/test/strategies/go.ts
@@ -47,7 +47,10 @@ describe('Go', () => {
 
     sandbox
       .stub(github, 'findFilesByGlobAndRef')
-      .resolves(['file-with-imports-v2.go']);
+      .withArgs('**/*.go', 'main')
+      .resolves(['file-with-imports-v2.go'])
+      .withArgs('**/*.md', 'main')
+      .resolves([]);
   });
   afterEach(() => {
     sandbox.restore();
diff --git a/test/updaters/fixtures/file-with-go-snippet-v1.md b/test/updaters/fixtures/file-with-go-snippet-v1.md
@@ -0,0 +1 @@
+- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/shared#ASNParam">ASNParam</a>
diff --git a/test/updaters/fixtures/file-with-go-snippet-v2.md b/test/updaters/fixtures/file-with-go-snippet-v2.md
@@ -0,0 +1 @@
+- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v2/shared#ASNParam">ASNParam</a>
diff --git a/test/updaters/fixtures/file-with-go-snippet-v3.md b/test/updaters/fixtures/file-with-go-snippet-v3.md
@@ -0,0 +1 @@
+- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/shared">shared</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/shared#ASNParam">ASNParam</a>
diff --git a/test/updaters/fixtures/file-with-imports-v1.go b/test/updaters/fixtures/file-with-imports-v1.go
@@ -15,4 +15,5 @@ import (
 	"github.com/cloudflare/cloudflare-go/internal/requestconfig"
 	"github.com/cloudflare/cloudflare-go/option"
 	"github.com/cloudflare/cloudflare-go/shared"
+	"github.com/cloudflare/cloudflare-go"
 )
diff --git a/test/updaters/fixtures/file-with-imports-v2.go b/test/updaters/fixtures/file-with-imports-v2.go
@@ -15,4 +15,5 @@ import (
 	"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
 	"github.com/cloudflare/cloudflare-go/v2/option"
 	"github.com/cloudflare/cloudflare-go/v2/shared"
+	"github.com/cloudflare/cloudflare-go/v2"
 )
diff --git a/test/updaters/fixtures/file-with-imports-v3.go b/test/updaters/fixtures/file-with-imports-v3.go
@@ -15,4 +15,5 @@ import (
 	"github.com/cloudflare/cloudflare-go/v3/internal/requestconfig"
 	"github.com/cloudflare/cloudflare-go/v3/option"
 	"github.com/cloudflare/cloudflare-go/v3/shared"
+	"github.com/cloudflare/cloudflare-go/v3"
 )
diff --git a/test/updaters/go-imports.ts b/test/updaters/go-imports.ts
@@ -8,46 +8,93 @@ import {GithubImportsGo} from '../../src/updaters/go/github-imports-go';
 const fixturesPath = './test/updaters/fixtures';
 
 describe('GithubImportsGo', () => {
-  const v1File = readFileSync(
-    resolve(fixturesPath, 'file-with-imports-v1.go'),
-    'utf8'
-  );
-
-  const v2File = readFileSync(
-    resolve(fixturesPath, 'file-with-imports-v2.go'),
-    'utf8'
-  );
-
-  const v3File = readFileSync(
-    resolve(fixturesPath, 'file-with-imports-v3.go'),
-    'utf8'
-  );
-
-  it('makes no changes if the old version has a major version of 1 and the new version also has a major version of 1', async () => {
-    const readmeUpdater = new GithubImportsGo({
-      version: Version.parse('1.0.0'),
-    });
-    expect(readmeUpdater.updateContent(v1File)).to.equal(v1File);
-  });
+  describe('.go files', () => {
+    const v1File = readFileSync(
+      resolve(fixturesPath, 'file-with-imports-v1.go'),
+      'utf8'
+    );
+
+    const v2File = readFileSync(
+      resolve(fixturesPath, 'file-with-imports-v2.go'),
+      'utf8'
+    );
+
+    const v3File = readFileSync(
+      resolve(fixturesPath, 'file-with-imports-v3.go'),
+      'utf8'
+    );
 
-  it('updates the version in the imports if the old version has a major version of 1 and the new version has a major version of 2', async () => {
-    const readmeUpdater = new GithubImportsGo({
-      version: Version.parse('2.0.0'),
+    it('makes no changes if the old version has a major version of 1 and the new version also has a major version of 1', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('1.0.0'),
+      });
+      expect(importsUpdater.updateContent(v1File)).to.equal(v1File);
     });
-    expect(readmeUpdater.updateContent(v1File)).to.equal(v2File);
-  });
 
-  it('makes no changes if the old version has a major version of 2 and the new version also has a major version of 2', async () => {
-    const readmeUpdater = new GithubImportsGo({
-      version: Version.parse('2.0.0'),
+    it('updates the version in the imports if the old version has a major version of 1 and the new version has a major version of 2', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('2.0.0'),
+      });
+      expect(importsUpdater.updateContent(v1File)).to.equal(v2File);
+    });
+
+    it('makes no changes if the old version has a major version of 2 and the new version also has a major version of 2', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('2.0.0'),
+      });
+      expect(importsUpdater.updateContent(v2File)).to.equal(v2File);
+    });
+
+    it('updates the version in the imports if the old version has a major version of 2 and the new version has a major version of 3', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('3.0.0'),
+      });
+      expect(importsUpdater.updateContent(v2File)).to.equal(v3File);
     });
-    expect(readmeUpdater.updateContent(v2File)).to.equal(v2File);
   });
 
-  it('updates the version in the imports if the old version has a major version of 2 and the new version has a major version of 3', async () => {
-    const readmeUpdater = new GithubImportsGo({
-      version: Version.parse('3.0.0'),
+  describe('.md files', () => {
+    const v1MdFile = readFileSync(
+      resolve(fixturesPath, 'file-with-go-snippet-v1.md'),
+      'utf8'
+    );
+
+    const v2MdFile = readFileSync(
+      resolve(fixturesPath, 'file-with-go-snippet-v2.md'),
+      'utf8'
+    );
+
+    const v3MdFile = readFileSync(
+      resolve(fixturesPath, 'file-with-go-snippet-v3.md'),
+      'utf8'
+    );
+
+    it('makes no changes if the old version has a major version of 1 and the new version also has a major version of 1', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('1.0.0'),
+      });
+      expect(importsUpdater.updateContent(v1MdFile)).to.equal(v1MdFile);
+    });
+
+    it('updates the version in the imports if the old version has a major version of 1 and the new version has a major version of 2', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('2.0.0'),
+      });
+      expect(importsUpdater.updateContent(v1MdFile)).to.equal(v2MdFile);
+    });
+
+    it('makes no changes if the old version has a major version of 2 and the new version also has a major version of 2', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('2.0.0'),
+      });
+      expect(importsUpdater.updateContent(v2MdFile)).to.equal(v2MdFile);
+    });
+
+    it('updates the version in the imports if the old version has a major version of 2 and the new version has a major version of 3', async () => {
+      const importsUpdater = new GithubImportsGo({
+        version: Version.parse('3.0.0'),
+      });
+      expect(importsUpdater.updateContent(v2MdFile)).to.equal(v3MdFile);
     });
-    expect(readmeUpdater.updateContent(v2File)).to.equal(v3File);
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,11 @@ export class GithubImportsGo extends DefaultUpdater {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`return content.replace(`
`10`		`- /"github\.com\/([^/]+)\/([^/]+)(\/v([1-9]\d*))?\/(.+)"/g,`
`11`		`- (_, user, repo, __, ___, path) =>`
`12`		- `"github.com/${user}/${repo}/v${this.version.major.toString()}/${path}"`
	`10`	`+ /"(https:\/\/pkg.go.dev\/)?github\.com\/([^/]+)\/([^/]+)(\/v([1-9]\d*))?(\/[^"]+)?"/g,`
	`11`	`+ (_, prefix, user, repo, ___, ____, path) =>`
	`12`	+ `"${prefix ?? ''}github.com/${user}/${repo}${
	`13`	`+ this.version.major < 2 ? '' : '/v' + this.version.major.toString()`
	`14`	+ }${path ?? ''}"`
`13`	`15`	`);`
`14`	`16`	`}`
`15`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/shared#ASNParam">ASNParam</a>`
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,5 @@ import (`
`15`	`15`	`"github.com/cloudflare/cloudflare-go/internal/requestconfig"`
`16`	`16`	`"github.com/cloudflare/cloudflare-go/option"`
`17`	`17`	`"github.com/cloudflare/cloudflare-go/shared"`
	`18`	`+ "github.com/cloudflare/cloudflare-go"`
`18`	`19`	`)`