Skip to content

Commit

Permalink
fix(github-release): release name is packageName
Browse files Browse the repository at this point in the history
Forming the contents of a release was factored out of GitHubRelease in
googleapis#720
The argument provide for the release name was accidentally swapped to be
the packagePrefix (e.g. sans @scope for node packages).
  • Loading branch information
joeldodge79 committed Feb 11, 2021
1 parent b277b89 commit 2983cf4
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 80 deletions.
77 changes: 0 additions & 77 deletions __snapshots__/github-release.js

This file was deleted.

2 changes: 2 additions & 0 deletions src/github-release.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ export interface ReleaseResponse {
version: string;
sha: string;
html_url: string;
name: string;
tag_name: string;
upload_url: string;
pr: number;
Expand Down Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions src/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ type CreateIssueCommentResponse = PromiseValue<
// ReturnType<InstanceType<typeof Octokit>['repos']['createRelease']>
// >['data'];
export type ReleaseCreateResponse = {
name: string;
tag_name: string;
draft: boolean;
html_url: string;
Expand Down
2 changes: 1 addition & 1 deletion src/release-pr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ export class ReleasePR {
sha: mergedPR.sha,
tag,
notes,
name: this.packagePrefix,
name: this.packageName,
version,
pullNumber: mergedPR.number,
};
Expand Down
26 changes: 24 additions & 2 deletions test/github-release.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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);
Expand Down Expand Up @@ -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',
Expand All @@ -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);
Expand Down Expand Up @@ -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',
Expand All @@ -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');
});

Expand Down Expand Up @@ -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',
Expand All @@ -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');
});

Expand Down Expand Up @@ -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',
Expand All @@ -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');
});

Expand Down Expand Up @@ -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',
Expand All @@ -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);
Expand Down Expand Up @@ -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',
Expand All @@ -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);
Expand Down Expand Up @@ -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',
Expand All @@ -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);
Expand Down

0 comments on commit 2983cf4

Please sign in to comment.