chore: updates to changelog before v1.0.0-rc.1 release by andynog · Pull Request #3253 · cometbft/cometbft

andynog · 2024-06-12T18:11:38Z

Partially close: #3255

This PR updates the CHANGELOG.md file with the unreleased information updated before the v1.0.0-rc.1 release cut (not that there's no v1.0.0-rc.1 release in the changelog, this will happen only when we cut v1.0.0 major release, no unclog release command was executed)

The changelog was updated using the command:

unclog build -a > CHANGELOG.md

This PR also includes a change in the unclog config.toml to sort entries by id since this seem to be the old behavior and it's easier to diff the file with the historical CHANGELOG.md (otherwise it would be sorted alphabetically and this change in ordering for the past releases which is can be very confusing to diff and compare).

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
Title follows the Conventional Commits spec

melekes

👍

.changelog/config.toml

cason

I don't have much background to understand this, but suggestions:

Could we have a Table of Contents?
Shouldn't updates be classified by "big" releases?
Why unreleased stuff is on the changelog?

CHANGELOG.md

…dating CHANGELOG.md (#3253)

andynog · 2024-06-19T20:11:24Z

@sergio-mena I've added the changes requested. In the last commits I've added these changes:

Re-added the summary.md doc.
Removed releases that should not be in the .changelog folder. I've ensured that these entries matched the entries in their respective releases (folder diff) so we are not loosing anything.
Many formatting fixes and adding information that was missing to ensure entries are consistent and accurate.
Re-generated the CHANGELOG.md file after these changes were in place.

melekes

👍

.changelog/unreleased/summary.md

CHANGELOG.md

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

.changelog/unreleased/summary.md

sergio-mena

Amazing 🚀, thanks @andynog !

Co-authored-by: Sergio Mena <sergio@informal.systems>

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

Co-authored-by: Sergio Mena <sergio@informal.systems>

Partially close: #3255 This PR updates the `CHANGELOG.md` file with the unreleased information updated before the `v1.0.0-rc.1` release cut (not that there's no `v1.0.0-rc.1` release in the changelog, this will happen only when we cut `v1.0.0` major release, no `unclog release` command was executed) The changelog was updated using the command: ``` unclog build -a > CHANGELOG.md ``` This PR also includes a change in the unclog `config.toml` to sort entries by `id` since this seem to be the old behavior and it's easier to diff the file with the historical `CHANGELOG.md` (otherwise it would be sorted alphabetically and this change in ordering for the past releases which is can be very confusing to diff and compare). #### PR checklist - [ ] Tests written/updated - [X] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec --------- Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com> Co-authored-by: Sergio Mena <sergio@informal.systems> (cherry picked from commit f4c622f) # Conflicts: # .changelog/unreleased/breaking-changes/2786-remove-cleveldb-boltdb.md # .changelog/unreleased/breaking-changes/2892-remove-skip-timeout-commit.md # .changelog/unreleased/breaking-changes/2895-merge-timeout-prevote-precommit.md # .changelog/unreleased/breaking-changes/3248-crypto-sha256.md # .changelog/unreleased/improvements/1958-disable-linting.md # .changelog/unreleased/improvements/3016-remove-expensive-calls-from-flowrate.md # .changelog/unreleased/improvements/3056-export-node-package-errors.md # .changelog/unreleased/improvements/3117-significantly-speedup-make-partset.md # .changelog/unreleased/improvements/3119-speedup-valset-GetByAddress-usages.md # .changelog/unreleased/improvements/3156-make-addvote-only-take-one-ps-mtx.md # .changelog/unreleased/improvements/3159-fix-taking-wlocks-instead-of-rlocks.md # .changelog/unreleased/improvements/3162-reuse-internal-buffer-for-block-building.md # .changelog/unreleased/improvements/3180-lower-broadcasts-consensus-overhead.md # .changelog/unreleased/summary.md # CHANGELOG.md

… (#3312) Partially close: #3255 This PR updates the `CHANGELOG.md` file with the unreleased information updated before the `v1.0.0-rc.1` release cut (not that there's no `v1.0.0-rc.1` release in the changelog, this will happen only when we cut `v1.0.0` major release, no `unclog release` command was executed) The changelog was updated using the command: ``` unclog build -a > CHANGELOG.md ``` This PR also includes a change in the unclog `config.toml` to sort entries by `id` since this seem to be the old behavior and it's easier to diff the file with the historical `CHANGELOG.md` (otherwise it would be sorted alphabetically and this change in ordering for the past releases which is can be very confusing to diff and compare). #### PR checklist - [ ] Tests written/updated - [X] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments - [X] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3253 done by [Mergify](https://mergify.com). --------- Co-authored-by: Andy Nogueira <me@andynogueira.dev>

Updates to changelog before v1.0.0-rc.1 release

f292163

andynog requested a review from a team as a code owner June 12, 2024 18:11

andynog requested a review from a team June 12, 2024 18:11

andynog self-assigned this Jun 12, 2024

andynog added release Pull requests that facilitate cutting a release backport-to-v1.x labels Jun 12, 2024

andynog added this to the 2024-Q2 milestone Jun 12, 2024

This was referenced Jun 12, 2024

chore: file updates for the v1.0.0-rc1 release #3189

Merged

chore: preparation for first release candidate v1.0.0-rc1 #3255

Closed

melekes approved these changes Jun 13, 2024

View reviewed changes

.changelog/config.toml Outdated Show resolved Hide resolved

Merge branch 'main' into andy/changelog-rc1-unreleased

32b9411

cason reviewed Jun 14, 2024

View reviewed changes

Merge branch 'main' into andy/changelog-rc1-unreleased

7d44362

sergio-mena reviewed Jun 19, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

sergio-mena reviewed Jun 19, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

sergio-mena reviewed Jun 19, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

sergio-mena reviewed Jun 19, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

andynog added 7 commits June 19, 2024 13:13

Merge branch 'main' into andy/changelog-rc1-unreleased

6f37335

fixing formatting (#3253)

3bab5cc

fixing formatting, missing info, adding summary.md back (#3253)

bd176a8

removing releases that should not be in the .changelog folder, and up…

100f93d

…dating CHANGELOG.md (#3253)

revert the previous entry sorting by text (#3253)

993f5f5

fixing feature formatting (#3253)

6b33505

few more fixes (#3253)

e71a254

andynog requested review from cason, melekes and sergio-mena June 19, 2024 19:57

melekes approved these changes Jun 20, 2024

View reviewed changes

.changelog/unreleased/summary.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

Update .changelog/unreleased/summary.md

744fdb3

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

sergio-mena reviewed Jun 20, 2024

View reviewed changes

.changelog/unreleased/summary.md Outdated Show resolved Hide resolved

sergio-mena reviewed Jun 20, 2024

View reviewed changes

.changelog/unreleased/summary.md Outdated Show resolved Hide resolved

sergio-mena reviewed Jun 20, 2024

View reviewed changes

.changelog/unreleased/summary.md Outdated Show resolved Hide resolved

sergio-mena approved these changes Jun 20, 2024

View reviewed changes

andynog and others added 6 commits June 20, 2024 13:59

Update .changelog/unreleased/summary.md

4e04af1

Co-authored-by: Sergio Mena <sergio@informal.systems>

Merge branch 'main' into andy/changelog-rc1-unreleased

d96e347

Update .changelog/unreleased/summary.md

a448af6

Co-authored-by: Sergio Mena <sergio@informal.systems>

Update CHANGELOG.md

ca5acf0

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

Update .changelog/unreleased/summary.md

c87abbc

Co-authored-by: Sergio Mena <sergio@informal.systems>

Adding updated CHANGELOG.md (#3253)

2b5f649

andynog added this pull request to the merge queue Jun 20, 2024

Merged via the queue into main with commit f4c622f Jun 20, 2024

andynog deleted the andy/changelog-rc1-unreleased branch June 20, 2024 18:35

mergify bot mentioned this pull request Jun 20, 2024

chore: updates to changelog before v1.0.0-rc.1 release (backport #3253) #3312

Merged

4 tasks

andynog added a commit that referenced this pull request Jun 20, 2024

fixing conflicts (#3253)

e65731f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: updates to changelog before v1.0.0-rc.1 release#3253

chore: updates to changelog before v1.0.0-rc.1 release#3253
andynog merged 17 commits intomainfrom
andy/changelog-rc1-unreleased

andynog commented Jun 12, 2024 •

edited

Loading

Uh oh!

melekes left a comment

Uh oh!

Uh oh!

cason left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andynog commented Jun 19, 2024

Uh oh!

melekes left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sergio-mena left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

andynog commented Jun 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

melekes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cason left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andynog commented Jun 19, 2024

Uh oh!

melekes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sergio-mena left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andynog commented Jun 12, 2024 •

edited

Loading