From 2983cf4668f6540ff4c029634bd9e3492d1bb187 Mon Sep 17 00:00:00 2001 From: Joel Dodge Date: Wed, 10 Feb 2021 01:49:22 +0000 Subject: [PATCH] fix(github-release): release name is packageName Forming the contents of a release was factored out of GitHubRelease in https://github.com/googleapis/release-please/pull/720 The argument provide for the release name was accidentally swapped to be the packagePrefix (e.g. sans @scope for node packages). --- __snapshots__/github-release.js | 77 --------------------------------- src/github-release.ts | 2 + src/github.ts | 1 + src/release-pr.ts | 2 +- test/github-release.ts | 26 ++++++++++- 5 files changed, 28 insertions(+), 80 deletions(-) delete mode 100644 __snapshots__/github-release.js diff --git a/__snapshots__/github-release.js b/__snapshots__/github-release.js deleted file mode 100644 index ab47b2697..000000000 --- a/__snapshots__/github-release.js +++ /dev/null @@ -1,77 +0,0 @@ -exports['GitHubRelease createRelease attempts to guess package name for release 1'] = { - "tag_name": "v1.0.3", - "body": "\n* entry", - "name": "@google-cloud/foo v1.0.3", - "draft": false -} - -exports['GitHubRelease createRelease attempts to guess package name for release 2'] = { - "labels": [ - "autorelease: tagged" - ] -} - -exports['GitHubRelease createRelease creates and labels release on GitHub 1'] = { - "tag_name": "v1.0.3", - "body": "\n* entry", - "name": "foo v1.0.3", - "draft": false -} - -exports['GitHubRelease createRelease creates and labels release on GitHub 2'] = { - "labels": [ - "autorelease: tagged" - ] -} - -exports['GitHubRelease createRelease supports submodules in nested folders 1'] = { - "tag_name": "foo/v1.0.3", - "body": "\n* entry", - "name": "foo foo/v1.0.3", - "draft": false -} - -exports['GitHubRelease createRelease supports submodules in nested folders 2'] = { - "labels": [ - "autorelease: tagged" - ] -} - -exports['GitHubRelease createRelease creates releases for submodule in monorepo 1'] = { - "tag_name": "bigquery/v1.0.3", - "body": "\n* entry", - "name": "bigquery bigquery/v1.0.3", - "draft": false -} - -exports['GitHubRelease createRelease creates releases for submodule in monorepo 2'] = { - "labels": [ - "autorelease: tagged" - ] -} - -exports['GitHubRelease createRelease attempts to guess package name for submodule release 1'] = { - "tag_name": "@google-cloud/foo-v1.0.3", - "body": "\n* entry", - "name": "@google-cloud/foo @google-cloud/foo-v1.0.3", - "draft": false -} - -exports['GitHubRelease createRelease attempts to guess package name for submodule release 2'] = { - "labels": [ - "autorelease: tagged" - ] -} - -exports['GitHubRelease createRelease creates a draft release 1'] = { - "tag_name": "v1.0.3", - "body": "\n* entry", - "name": "foo v1.0.3", - "draft": true -} - -exports['GitHubRelease createRelease creates a draft release 2'] = { - "labels": [ - "autorelease: tagged" - ] -} diff --git a/src/github-release.ts b/src/github-release.ts index f35117043..5016dce3d 100644 --- a/src/github-release.ts +++ b/src/github-release.ts @@ -32,6 +32,7 @@ export interface ReleaseResponse { version: string; sha: string; html_url: string; + name: string; tag_name: string; upload_url: string; pr: number; @@ -152,6 +153,7 @@ export class GitHubRelease { version: candidate.version, pr: candidate.pullNumber, html_url: release.html_url, + name: release.name, tag_name: release.tag_name, upload_url: release.upload_url, draft: release.draft, diff --git a/src/github.ts b/src/github.ts index 2742d08d3..6f8837356 100644 --- a/src/github.ts +++ b/src/github.ts @@ -46,6 +46,7 @@ type CreateIssueCommentResponse = PromiseValue< // ReturnType['repos']['createRelease']> // >['data']; export type ReleaseCreateResponse = { + name: string; tag_name: string; draft: boolean; html_url: string; diff --git a/src/release-pr.ts b/src/release-pr.ts index dec4099ac..5c0a138c6 100644 --- a/src/release-pr.ts +++ b/src/release-pr.ts @@ -444,7 +444,7 @@ export class ReleasePR { sha: mergedPR.sha, tag, notes, - name: this.packagePrefix, + name: this.packageName, version, pullNumber: mergedPR.number, }; diff --git a/test/github-release.ts b/test/github-release.ts index 2cbb169a6..0c0957631 100644 --- a/test/github-release.ts +++ b/test/github-release.ts @@ -74,6 +74,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('foo', `v${version}`, 'abc123', '\n* entry', !!options?.draft) .resolves({ + name: `foo v${version}`, tag_name: `v${version}`, draft: !!options?.draft, html_url: 'https://release.url', @@ -100,6 +101,7 @@ describe('GitHubRelease', () => { it('creates and labels release on GitHub', async () => { const releaser = gitHubReleaserForVersion('1.0.3'); const created = await releaser.run(); + strictEqual(created!.name, 'foo v1.0.3'); strictEqual(created!.tag_name, 'v1.0.3'); strictEqual(created!.major, 1); strictEqual(created!.minor, 0); @@ -156,6 +158,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('bigquery', 'bigquery/v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: 'bigquery bigquery/v1.0.3', tag_name: 'bigquery/v1.0.3', draft: false, html_url: 'https://release.url', @@ -179,6 +182,7 @@ describe('GitHubRelease', () => { const created = await release.run(); expect(created).to.not.be.undefined; + strictEqual(created!.name, 'bigquery bigquery/v1.0.3'); strictEqual(created!.tag_name, 'bigquery/v1.0.3'); strictEqual(created!.major, 1); strictEqual(created!.minor, 0); @@ -220,6 +224,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('foo', 'foo/v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: 'foo foo/v1.0.3', tag_name: 'foo/v1.0.3', draft: false, html_url: 'https://release.url', @@ -242,6 +247,7 @@ describe('GitHubRelease', () => { .resolves(); const created = await release.run(); + strictEqual(created!.name, 'foo foo/v1.0.3'); strictEqual(created!.tag_name, 'foo/v1.0.3'); }); @@ -283,8 +289,15 @@ describe('GitHubRelease', () => { sandbox .stub(release.gh, 'createRelease') - .withArgs('foo', 'foo-v1.0.3', 'abc123', '\n* entry', false) + .withArgs( + '@google-cloud/foo', + 'foo-v1.0.3', + 'abc123', + '\n* entry', + false + ) .resolves({ + name: '@google-cloud/foo foo-v1.0.3', tag_name: 'foo-v1.0.3', draft: false, html_url: 'https://release.url', @@ -308,6 +321,7 @@ describe('GitHubRelease', () => { const created = await release.run(); expect(created).to.not.be.undefined; + strictEqual(created!.name, '@google-cloud/foo foo-v1.0.3'); strictEqual(created!.tag_name, 'foo-v1.0.3'); }); @@ -349,8 +363,9 @@ describe('GitHubRelease', () => { sandbox .stub(release.gh, 'createRelease') - .withArgs('foo', 'v1.0.3', 'abc123', '\n* entry', false) + .withArgs('@google-cloud/foo', 'v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: '@google-cloud/foo v1.0.3', tag_name: 'v1.0.3', draft: false, html_url: 'https://release.url', @@ -373,6 +388,7 @@ describe('GitHubRelease', () => { .resolves(); const created = await release.run(); + strictEqual(created!.name, '@google-cloud/foo v1.0.3'); strictEqual(created!.tag_name, 'v1.0.3'); }); @@ -474,6 +490,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('foo', 'v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: 'foo v1.0.3', tag_name: 'v1.0.3', draft: false, html_url: 'https://release.url', @@ -497,6 +514,7 @@ describe('GitHubRelease', () => { const created = await release.run(); expect(created).to.not.be.undefined; + strictEqual(created!.name, 'foo v1.0.3'); strictEqual(created!.tag_name, 'v1.0.3'); strictEqual(created!.major, 1); strictEqual(created!.minor, 0); @@ -536,6 +554,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('foo', 'v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: 'foo v1.0.3', tag_name: 'v1.0.3', draft: false, html_url: 'https://release.url', @@ -559,6 +578,7 @@ describe('GitHubRelease', () => { const created = await release.run(); expect(created).to.not.be.undefined; + strictEqual(created!.name, 'foo v1.0.3'); strictEqual(created!.tag_name, 'v1.0.3'); strictEqual(created!.major, 1); strictEqual(created!.minor, 0); @@ -670,6 +690,7 @@ describe('GitHubRelease', () => { .stub(release.gh, 'createRelease') .withArgs('', 'v1.0.3', 'abc123', '\n* entry', false) .resolves({ + name: 'v1.0.3', tag_name: 'v1.0.3', draft: false, html_url: 'https://release.url', @@ -692,6 +713,7 @@ describe('GitHubRelease', () => { .resolves(); const created = await release.run(); + strictEqual(created!.name, 'v1.0.3'); strictEqual(created!.tag_name, 'v1.0.3'); strictEqual(created!.major, 1); strictEqual(created!.minor, 0);