Skip to content

chore: clean-up changelog #15253

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 4 commits into from
Mar 3, 2023
Merged

chore: clean-up changelog #15253

merged 4 commits into from
Mar 3, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 2, 2023

Description

I was looking for a method to speed up and facilitate the fact of removing entries from the unreleased section of the changelog (like done at each release 1edc60b, 1133b6b, ...)

I used a small script where I moved beforehand the unreleased changelog to CHANGELOG_PENDING.md and left the rest in CHANGELOG.md.

Then ran grep -vxFf $2 $1 > $1.tmp && mv $1.tmp $1 for removing the duplicate lines. ($2 = changelog_pending and $1 = changelog.md)
Afterward, I re-added that changelog pending back in CHANGELOG.md with the proper headers.

As we can see, there were still many duplicates entries from unreleased.
I am working on making the process above just one script, but in the meantime, the changelog can already be cleaned.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt requested a review from a team March 2, 2023 23:01
@github-prbot github-prbot requested review from a team, JeancarloBarrios and atheeshp and removed request for a team March 2, 2023 23:01
@julienrbrt julienrbrt requested a review from tac0turtle March 2, 2023 23:05
@tac0turtle tac0turtle merged commit 8fb95f0 into main Mar 3, 2023
@tac0turtle tac0turtle deleted the julien/changelog branch March 3, 2023 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants