Skip to content
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

docs(changelog): remove unnecessary entries #36264

Closed

Conversation

cerkiner
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Unnecessary, repeating entries in the changelog

Issue Number: N/A

What is the new behavior?

Remove unnecessary, repeating entries in the changelog

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

The earliest mention of each entry is kept and duplicate entries mentioned in newer versions are removed.

@ngbot ngbot bot added this to the needsTriage milestone Apr 9, 2020
@cerkiner
Copy link
Contributor Author

Is anyone interested in this fix? @filipesilva @atscott

@pullapprove pullapprove bot requested a review from kara May 18, 2020 17:53
@filipesilva filipesilva removed their request for review May 18, 2020 17:58
@cerkiner
Copy link
Contributor Author

Is anyone interested in this fix? @kara

@kapunahelewong kapunahelewong added effort1: hours action: review The PR is still awaiting reviews from at least one requested reviewer risk: low type: bug/fix labels Jun 25, 2020
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Jun 25, 2020
@kapunahelewong kapunahelewong removed the request for review from kara June 25, 2020 17:58
@kapunahelewong
Copy link
Contributor

Hi @cerkiner, thank you for this PR. I'm sorry for the delay. We are working on catching up with the issues and PRs backlog. I have added the appropriate labels, including PR action: review, which puts it in the queue for engineering to review. Just so you know, ultimately you will need to rebase. If that's not part of your regular workflow, I can help you with it. If you have any questions in the meantime, just tag me.

Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

the second commit looks good, but the first one has removals which I don't understand.

Can you please explain what key you used to determine which entries to keep and which to remove?

Also, can you please follow our commit message convention and ensure that the CI lint checks pass? thanks

@pullapprove pullapprove bot requested a review from IgorMinar June 25, 2020 20:04
Copy link
Contributor

@IgorMinar IgorMinar left a comment

Choose a reason for hiding this comment

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

Reviewed-for: public-api

@cerkiner
Copy link
Contributor Author

cerkiner commented Jun 29, 2020

@IgorMinar I first realised there are duplicate entries for same changes and fixes, while I am fixing the issue, I realised there are some titles with no entries.

6972401 Removes duplicate entries by keeping the earliest mention of each entry.
d24de59 Removes the empty titles

I can apply the same changes to recent change log entries as well.

@jelbourn
Copy link
Member

@cerkiner would you mind squashing your changes into just two commits?

docs(changelog): remove duplicate entries

Remove duplicate entries in the changelog, keeping only the earliest instance of changes that appear multiple times.
docs(changelog): remove empty sections

The changelog contains some empty sections (such as `### Bug Fixes`). This change removes these empty sections.

Remove duplicate entries in the changelog, keeping only the earliest instance of changes that appear multiple times.
The changelog contains some empty sections (such as `### Bug Fixes`). This change removes these empty sections.
@cerkiner cerkiner force-pushed the remove-unnecessary-changelog-entries branch from 3b8870f to 379f131 Compare June 30, 2020 01:07
@cerkiner
Copy link
Contributor Author

@jelbourn Thank you for the copy, I used it exactly as is. I also applied the same changes to recent changelog entries.

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

Reviewed-for: global-approvers

@jelbourn jelbourn dismissed IgorMinar’s stale review June 30, 2020 20:13

Commit message has been updated

@jelbourn jelbourn added target: major This PR is targeted for the next major release 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 labels Jun 30, 2020
AndrewKushnir pushed a commit that referenced this pull request Jul 1, 2020
The changelog contains some empty sections (such as `### Bug Fixes`). This change removes these empty sections.

PR Close #36264
@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 Aug 1, 2020
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020
Remove duplicate entries in the changelog, keeping only the earliest instance of changes that appear multiple times.

PR Close angular#36264
profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020
The changelog contains some empty sections (such as `### Bug Fixes`). This change removes these empty sections.

PR Close angular#36264
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 effort1: hours risk: low target: major This PR is targeted for the next major release type: bug/fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants