Skip to content

feat(dev-infra): Set up new common release notes generation tooling #41905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

feat(dev-infra): Set up new common release notes generation tooling #41905

wants to merge 2 commits into from

Conversation

josephperrott
Copy link
Member

Enables the new common release notes generation within the ng-dev release publishing tooling.

@josephperrott josephperrott added action: review The PR is still awaiting reviews from at least one requested reviewer target: patch This PR is targeted for the next patch release area: dev-infra Issues related to Angular's own dev infra (build, test, CI, releasing) labels Apr 30, 2021
@ngbot ngbot bot modified the milestone: Backlog Apr 30, 2021
@google-cla google-cla bot added the cla: yes label Apr 30, 2021
@josephperrott josephperrott force-pushed the release-notes branch 2 times, most recently from aee664d to 2333661 Compare April 30, 2021 20:19
@josephperrott josephperrott marked this pull request as ready for review April 30, 2021 20:19
@petebacondarwin
Copy link
Contributor

Can you therefore delete this file: https://github.com/angular/angular/blob/master/tools/gulp-tasks/changelog.js
And perhaps the zone.js one too?

devversion
devversion approved these changes May 3, 2021
View reviewed changes
Copy link
Member

@devversion devversion left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall. Just a few minor comments.

Great improvement!! much simpler and more reliable.

dev-infra/release/publish/actions.ts Outdated
newVersion: semver.SemVer, pullRequestBaseBranch: string): Promise<PullRequest> {
newVersion: semver.SemVer, pullRequestBaseBranch: string):
Promise<{releaseNotes: ReleaseNotes, pullRequest: PullRequest}> {
const releaseNotes = new ReleaseNotes(newVersion, this.config);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@josephperrott What do you think of making the ReleaseNotes constructor private and exposing a static method like ReleaseNotes.fromLatestTagToHead. I'm proposing this because right now it's not quite clear that the commits are determined at this point. This is relevant/important because if we'd not do that here, then later if we cherry-pick release notes with the next branch checked out, the commits would be different.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I also made it async so that we are able to leverage that if needed in the future. I could see us wanting to have the commit list retrieval be handled in the static builder method potentially in the future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed 👍

devversion
devversion approved these changes May 3, 2021
View reviewed changes
Copy link
Member

@devversion devversion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (lint seems to be failing; but other than that this looks great to me)

@josephperrott josephperrott added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer action: merge The PR is ready for merge by the caretaker labels May 3, 2021
@josephperrott josephperrott removed the request for review from gkalpak May 5, 2021 16:25
@josephperrott
feat(dev-infra): Set up new common release notes generation tooling
b023693 
Enables the new common release notes generation within the ng-dev release publishing
tooling.
@josephperrott
build: update release configuration to use new release notes system
ebaf98f 
Update the ng-dev config for release to use the new release notes system
for generating release notes.
@alxhub alxhub added target: rc This PR is targeted for the next release-candidate and removed target: patch This PR is targeted for the next patch release labels May 6, 2021
alxhub pushed a commit that referenced this pull request May 6, 2021
@josephperrott @alxhub
feat(dev-infra): Set up new common release notes generation tooling (#…
4d18e31 
…41905)

Enables the new common release notes generation within the ng-dev release publishing
tooling.

PR Close #41905
alxhub pushed a commit that referenced this pull request May 6, 2021
@josephperrott @alxhub
build: update release configuration to use new release notes system (#…
cbe01a3 
…41905)

Update the ng-dev config for release to use the new release notes system
for generating release notes.

PR Close #41905
@alxhub alxhub closed this in 393ce94 May 6, 2021
alxhub pushed a commit that referenced this pull request May 6, 2021
@josephperrott @alxhub
build: update release configuration to use new release notes system (#…
5c9bd23 
…41905)

Update the ng-dev config for release to use the new release notes system
for generating release notes.

PR Close #41905
alxhub pushed a commit that referenced this pull request May 6, 2021
@josephperrott @alxhub
feat(dev-infra): Set up new common release notes generation tooling (#…
41becf3 
…41905)

Enables the new common release notes generation within the ng-dev release publishing
tooling.

PR Close #41905
alxhub pushed a commit that referenced this pull request May 6, 2021
@josephperrott @alxhub
build: update release configuration to use new release notes system (#…
4fac102 
…41905)

Update the ng-dev config for release to use the new release notes system
for generating release notes.

PR Close #41905
@alxhub
Copy link
Member

alxhub commented May 6, 2021

This had a trivial conflict with the patch branch (the built ng-dev.js target itself). It merged to master and 12.0.x via tooling, and then I cherry-picked the changes onto 11.2.x and rebuilt ng-dev.js to resolve the conflict.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Jun 6, 2021
@josephperrott josephperrott deleted the release-notes branch August 31, 2023 17:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@devversion devversion devversion approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker area: dev-infra Issues related to Angular's own dev infra (build, test, CI, releasing) cla: yes target: rc This PR is targeted for the next release-candidate
Projects
None yet
Milestone
Backlog
Development

Successfully merging this pull request may close these issues.
4 participants
@josephperrott @petebacondarwin @alxhub @devversion