Skip to content

build: group commits by package name in changelog #23460

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.

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

Merged
merged 1 commit into from
Aug 31, 2021

Conversation

devversion
Copy link
Member

Currently the new release tooling groups changes in the
changelog based on their commit scope. This is the default
behavior that works well for FW and the CLI repo.

For the components repository, we also include secondary entry-point
information in commit messages. This currently results in
many unnecessary groups, while ideally we'd want to group
based on the package name in the scope. This commit implements
that.

@devversion devversion requested a review from a team as a code owner August 26, 2021 13:13
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Aug 26, 2021
Copy link
Member

@josephperrott josephperrott left a comment

Choose a reason for hiding this comment

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

LGTM

@devversion devversion added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Aug 26, 2021
groupOrder: releasePackages,
categorizeCommit: commit => {
const [packageName, entryPointName] = commit.scope.split('/');
const entryPointPrefix = entryPointName ? `${entryPointName}: ` : '';
Copy link
Member Author

Choose a reason for hiding this comment

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

@josephperrott should we make this bold?

Copy link
Member Author

Choose a reason for hiding this comment

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

I added it now; I think that is a good thing, and we did it like that before with the legacy tooling as well.

Currently the new release tooling groups changes in the
changelog based on their commit scope. This is the default
behavior that works well for FW and the CLI repo.

For the components repository, we also include secondary entry-point
information in commit messages. This currently results in
many unnecessary groups, while ideally we'd want to group
based on the package name in the scope. This commit implements
that.
@devversion devversion force-pushed the build-better-changelog-grouping branch from e3d4a17 to 337025f Compare August 26, 2021 19:54
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

lgtm

@mmalerba mmalerba merged commit 9aa21dc into angular:master Aug 31, 2021
mmalerba pushed a commit that referenced this pull request Aug 31, 2021
Currently the new release tooling groups changes in the
changelog based on their commit scope. This is the default
behavior that works well for FW and the CLI repo.

For the components repository, we also include secondary entry-point
information in commit messages. This currently results in
many unnecessary groups, while ideally we'd want to group
based on the package name in the scope. This commit implements
that.

(cherry picked from commit 9aa21dc)
@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 Oct 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants