Skip to content

Commit 85eab90

Browse files
alan-agius4josephperrott
authored andcommitted
fix(ng-dev): remove version and date from GitHub release (#2662)
The version and date are already displayed on the GitHub release page. Additionally, the `v` prefix has been removed from the title. PR Close #2662
1 parent f9c5a81 commit 85eab90

File tree

7 files changed

+6
-35
lines changed

7 files changed

+6
-35
lines changed

ng-dev/release/notes/context.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,6 @@ const typesToIncludeInReleaseNotes = Object.values(COMMIT_TYPES)
1717
.filter((type) => type.releaseNotesLevel === ReleaseNotesLevel.Visible)
1818
.map((type) => type.name);
1919

20-
/** List of commit authors which are bots. */
21-
const botsAuthorNames = [
22-
'dependabot[bot]',
23-
'Renovate Bot',
24-
'angular-robot',
25-
'angular-robot[bot]',
26-
'Angular Robot',
27-
];
28-
2920
/** Data used for context during rendering. */
3021
export interface RenderContextData {
3122
title: string | false;

ng-dev/release/notes/templates/github-release.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
*/
88

99
export default `
10-
<a name="<%- urlFragmentForRelease %>"></a>
11-
# <%- version %><% if (title) { %> "<%- title %>"<% } %> (<%- dateStamp %>)
12-
1310
<%_
1411
const commitsInChangelog = commits.filter(includeInReleaseNotes());
1512
for (const group of asCommitGroups(commitsInChangelog)) {

ng-dev/release/publish/actions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ export abstract class ReleaseAction {
666666

667667
await this.git.github.repos.createRelease({
668668
...this.git.remoteParams,
669-
name: `v${releaseNotes.version}`,
669+
name: releaseNotes.version.toString(),
670670
tag_name: tagName,
671671
prerelease: isPrerelease,
672672
make_latest: showAsLatestOnGitHub ? 'true' : 'false',

ng-dev/release/publish/test/branch-off-next-branch-testing.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ async function expectGithubApiRequestsForBranchOff(
5353
})
5454
.expectTagToBeCreated(expectedTagName, 'STAGING_COMMIT_SHA')
5555
.expectReleaseToBeCreated(
56-
`v${expectedVersion}`,
56+
expectedVersion,
5757
expectedTagName,
5858
// Note: Currently when we branch off, we never release a "latest" stable version.
5959
false,

ng-dev/release/publish/test/common.spec.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ describe('common release action logic', () => {
192192
ahead_by: 1,
193193
})
194194
.expectTagToBeCreated(tagName, 'STAGING_SHA')
195-
.expectReleaseToBeCreated(`v${version}`, tagName, true);
195+
.expectReleaseToBeCreated(version.toString(), tagName, true);
196196

197197
// Set up a custom NPM registry.
198198
releaseConfig.publishRegistry = customRegistryUrl;
@@ -239,11 +239,10 @@ describe('common release action logic', () => {
239239
})
240240
.expectTagToBeCreated(tagName, 'STAGING_SHA')
241241
.expectReleaseToBeCreated(
242-
`v${version}`,
242+
version.toString(),
243243
tagName,
244244
true,
245245
changelogPattern`
246-
# 10.1.0-next.0 <..>
247246
### test
248247
| Commit | Description |
249248
| -- | -- |
@@ -343,7 +342,7 @@ describe('common release action logic', () => {
343342
})
344343
.expectTagToBeCreated(tagName, 'STAGING_SHA')
345344
.expectReleaseToBeCreated(
346-
`v${version}`,
345+
version.toString(),
347346
tagName,
348347
true,
349348
changelogPattern`

ng-dev/release/publish/test/release-notes/generation.spec.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,6 @@ describe('release notes generation', () => {
255255
);
256256

257257
expect(await releaseNotes.getChangelogEntry()).toMatch(changelogPattern`
258-
# 13.0.0 <..>
259258
## Breaking Changes
260259
### cdk/a11y
261260
- Description of breaking change.
@@ -289,7 +288,6 @@ describe('release notes generation', () => {
289288
);
290289

291290
expect(await releaseNotes.getChangelogEntry()).toMatch(changelogPattern`
292-
# 13.0.0 <..>
293291
## Breaking Changes
294292
### cdk/a11y
295293
- Description of breaking change.
@@ -320,7 +318,6 @@ describe('release notes generation', () => {
320318
);
321319

322320
expect(await releaseNotes.getChangelogEntry()).toMatch(changelogPattern`
323-
# 13.0.0 <..>
324321
## Deprecations
325322
### cdk/a11y
326323
- Description of deprecation.
@@ -351,7 +348,6 @@ describe('release notes generation', () => {
351348
);
352349

353350
expect(await releaseNotes.getChangelogEntry()).toMatch(changelogPattern`
354-
# 13.0.0 <..>
355351
## Deprecations
356352
### cdk/a11y
357353
- Description of deprecation.
@@ -383,7 +379,6 @@ describe('release notes generation', () => {
383379
);
384380

385381
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
386-
# 13.0.0 <..>
387382
### @angular-devkit/core
388383
| Commit | Description |
389384
| -- | -- |
@@ -418,7 +413,6 @@ describe('release notes generation', () => {
418413
);
419414

420415
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
421-
# 13.0.0 <..>
422416
### cdk
423417
| Commit | Description |
424418
| -- | -- |
@@ -457,7 +451,6 @@ describe('release notes generation', () => {
457451
);
458452

459453
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
460-
# 13.0.0 <..>
461454
### cdk/a11y
462455
| Commit | Description |
463456
| -- | -- |
@@ -499,7 +492,6 @@ describe('release notes generation', () => {
499492
);
500493

501494
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
502-
# 13.0.0 <..>
503495
### cdk
504496
| Commit | Description |
505497
| -- | -- |
@@ -531,7 +523,6 @@ describe('release notes generation', () => {
531523
);
532524

533525
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
534-
# 13.0.0 <..>
535526
### cdk/a11y
536527
| Commit | Description |
537528
| -- | -- |
@@ -562,7 +553,6 @@ describe('release notes generation', () => {
562553
);
563554

564555
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
565-
# 13.0.0 <..>
566556
### cdk/a11y
567557
| Commit | Description |
568558
| -- | -- |
@@ -592,7 +582,6 @@ describe('release notes generation', () => {
592582
);
593583

594584
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
595-
# 13.0.0 <..>
596585
### cdk/a11y
597586
| Commit | Description |
598587
| -- | -- |
@@ -624,7 +613,6 @@ describe('release notes generation', () => {
624613
);
625614

626615
expect(await releaseNotes.getGithubReleaseEntry()).toMatch(changelogPattern`
627-
# 13.0.0 <..>
628616
### cdk/a11y
629617
| Commit | Description |
630618
| -- | -- |

ng-dev/release/publish/test/test-utils/staging-test.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,7 @@ export async function expectGithubApiRequests(
8585
ahead_by: 1,
8686
})
8787
.expectTagToBeCreated(expectedTagName, 'STAGING_COMMIT_SHA')
88-
.expectReleaseToBeCreated(
89-
`v${expectedVersion}`,
90-
expectedTagName,
91-
opts.willShowAsLatestOnGitHub,
92-
);
88+
.expectReleaseToBeCreated(expectedVersion, expectedTagName, opts.willShowAsLatestOnGitHub);
9389
}
9490

9591
function expectNpmPublishToBeInvoked(packages: NpmPackage[], expectedNpmDistTag: NpmDistTag) {

0 commit comments

Comments
 (0)