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

Switch to unclog to parallelize changelog updates #891

Merged
merged 5 commits into from
Jun 3, 2021

Conversation

thanethomson
Copy link
Contributor

@thanethomson thanethomson commented Jun 2, 2021

As per out-of-band discussions, we noticed that we often end up in a situation where we're working on several PRs simultaneously, each of which modifies the CHANGELOG.md file but makes changes to distinct parts of the code base. This inevitably results in annoying merge conflicts purely related to the changelog.

The simplest solution seems to be to disaggregate changelog entries and build CHANGELOG.md from those entries as we perform a release.

For this, I built unclog, which is a small CLI tool written in Rust, to help manage these disaggregated changelog entries.

  • Referenced an issue explaining the need for the change
  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Added entry in .changelog/

Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson changed the title Switch to unclog to paralellize changelog updates Switch to unclog to parallelize changelog updates Jun 2, 2021
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson marked this pull request as ready for review June 2, 2021 21:13
Copy link
Contributor

@xla xla left a comment

Choose a reason for hiding this comment

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

⬆️ 🏥 💂 🌊

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.

2 participants