Skip to content

Conversation

thanethomson
Copy link
Contributor

@thanethomson thanethomson commented Mar 6, 2023

Updates our root changelog and upgrading guidelines on main to sync them with what we have on v0.34.x and v0.37.x.

Also makes a few minor changes to the README.


PR checklist

  • Tests written/updated
  • Changelog entry added in .changelog (we use unclog to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments

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>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson added the documentation Improvements or additions to documentation label Mar 6, 2023
@thanethomson thanethomson requested a review from a team as a code owner March 6, 2023 18:03
@@ -0,0 +1,2 @@
- Use Go 1.19 to build CometBFT, since Go 1.18 has reached end-of-life.
Copy link
Contributor

Choose a reason for hiding this comment

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

Since there is #385 listed below, I'm not sure including this done achieves anything (think of a user reading these). It could even be misleading.

I'd remove this one

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll do this in a follow-up PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, but isn't #385 relevant to v0.37.0, while #360 is relevant to v0.34.27?

@mergify mergify bot merged commit 8933dd4 into main Mar 14, 2023
@mergify mergify bot deleted the thane/post-release-docs-update branch March 14, 2023 16:00
@sergio-mena
Copy link
Contributor

Question: let's say we backport something (next week) from main to v0.37.x. How do we make sure the changelog for that change also lands on the v0.37x section on branch main?

@thanethomson
Copy link
Contributor Author

Question: let's say we backport something (next week) from main to v0.37.x. How do we make sure the changelog for that change also lands on the v0.37x section on branch main?

This is a good question. I've been thinking about this recently, and I would say that we should probably only add changelog entries to PRs in two cases:

  1. When we're submitting a PR to main that won't be backported (i.e. it'll land on the new backport branch we create when we start work towards a new version, so we'd want a changelog entry for it by then).
  2. When we're submitting a PR to a backport branch (e.g. v0.34.x and v0.37.x). In this case, if the initial PR to main, then we shouldn't include the changelog entry there - only on the backport PRs to the backport branches.

This way, when we cut a new release, it's easy to just copy across all the .changelog entries to main for those releases when we cut them. Otherwise we'll end up with duplicate or incorrect changelog entries that we then need to de-duplicate (this is also a valid approach, but arguably more difficult and time-consuming than doing the work up-front).

I'll see if there's an easy way to codify this in our PR template and contributing guidelines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge documentation Improvements or additions to documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants