From 9383fd364bc16d02e264c3f5b5c5fca9193a9135 Mon Sep 17 00:00:00 2001 From: Rootul Patel Date: Thu, 17 Oct 2024 14:19:28 -0400 Subject: [PATCH] chore: move pending-release to release-notes --- docs/release-notes/pending-release.md | 11 ----------- docs/release-notes/release-notes.md | 19 +++++++++++++++++-- 2 files changed, 17 insertions(+), 13 deletions(-) delete mode 100644 docs/release-notes/pending-release.md diff --git a/docs/release-notes/pending-release.md b/docs/release-notes/pending-release.md deleted file mode 100644 index 80c7c228eb..0000000000 --- a/docs/release-notes/pending-release.md +++ /dev/null @@ -1,11 +0,0 @@ -# Pending Nelease - -## v3.0.0 [Unreleased] - -### Node Operators - -- Consensus node operators should enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3774](https://github.com/celestiaorg/celestia-app/pull/3774). - -### Library Consumers - -- Namespace and share constants in the `appconsts` package were moved to [celestiaorg/go-square](https://github.com/celestiaorg/go-square). See [#3765](https://github.com/celestiaorg/celestia-app/pull/3765). diff --git a/docs/release-notes/release-notes.md b/docs/release-notes/release-notes.md index c5031566e5..880a7b3b5d 100644 --- a/docs/release-notes/release-notes.md +++ b/docs/release-notes/release-notes.md @@ -4,7 +4,7 @@ This guide provides notes for major version releases. These notes may be helpful ## [v2.0.0](https://github.com/celestiaorg/celestia-app/releases/tag/v2.0.0) -### Node Operators +### Node Operators (v2.0.0) If you are a consensus node operator, please follow the communication channels listed under [network upgrades](https://docs.celestia.org/nodes/participate#network-upgrades) to learn when this release is recommended for each network (e.g. Mocha, Mainnet Beta). @@ -12,7 +12,7 @@ Consensus node operators are expected to upgrade to this release _prior_ to the Consensus node operators should enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3812](https://github.com/celestiaorg/celestia-app/pull/3812). -### Library Consumers +### Library Consumers (v2.0.0) If you are a library consumer, a number of the Go APIs have changed since celestia-app v1.x.x. Some of the notable changes are: @@ -20,3 +20,18 @@ If you are a library consumer, a number of the Go APIs have changed since celest - celestia-app v1.x had a shares package. celestia-app v2.x uses [go-square/shares](https://github.com/celestiaorg/go-square/tree/c8242f96a844956f8d1c60e5511104deed8bc361/shares) - celestia-app v1.x had a blob.types package with `CreateCommitment` function. celestia-app v2.x uses `CreateCommitment` function from the [go-square/inclusion](https://github.com/celestiaorg/go-square/tree/c8242f96a844956f8d1c60e5511104deed8bc361/inclusion). - celestia-app v1.x had a lot of functionality included in the signer. celestia-app v2.x splits a txClient from the signer. See [#3433](https://github.com/celestiaorg/celestia-app/pull/3433). + +## [v3.0.0-rc0](https://github.com/celestiaorg/celestia-app/releases/tag/v3.0.0-rc0) + +### Node Operators (v3.0.0-rc0) + +- Consensus node operators must enable the BBR (Bottleneck Bandwidth and Round-trip propagation time) congestion control algorithm. See [#3774](https://github.com/celestiaorg/celestia-app/pull/3774). +- Consensus node operators should manually configure their node's mempool `ttl-num-blocks = 12`. An example command to do this: + + ```bash + sed -i 's/ttl-num-blocks = 5/ttl-num-blocks = 12/' ~/.celestia-app/config/config.toml + ``` + +### Library Consumers (v3.0.0-rc0) + +- Namespace and share constants in the `appconsts` package were moved to [celestiaorg/go-square](https://github.com/celestiaorg/go-square). See [#3765](https://github.com/celestiaorg/celestia-app/pull/3765).