Rebrand to CometBFT in naming, documentation, links #6
Conversation
Change documentation and URLs to CometBFT. Reviewed changes in the cometbft crate.
Change to CometBFT naming in documentation, file paths and URLs.
Change to CometBFT naming in documentation and URLs. Also updated the CLI and attack detector crates.
Change to CometBFT naming in documentation and URLs.
Change to CometBFT naming in documentation and URLs.
Change to CometBFT naming in documentation and URLs.
Change to CometBFT naming in documentation and URLs.
As part of the rename, environment variables affecting Dockerfile builds have been changed: TMHOME -> CMTHOME TMVERSION -> CMTVERSION The docker image name has been changed to informaldev/cometbft.
Changed naming and repository URLs to refer to CometBFT. Exceptions were made for links to old content, GitHub issues/PRs, etc. that have not been replicated in the cometbft org repos.
There was a problem hiding this comment.
Please truncate the CHANGELOG.md file by doing a similar thing to what we did with CometBFT's changelog here: https://github.com/cometbft/cometbft/blob/main/CHANGELOG.md#previous-changes
Since cometbft-rs is a fork of tendermint-rs, we should indicate that at the bottom of the changelog. To do this with unclog, you'll need to:
- Delete all releases' changelog entries in
.changelog - Add an epilogue like https://github.com/cometbft/cometbft/blob/main/.changelog/epilogue.md
I imagine that we'll be cutting cometbft-rs v1.0.0-alpha.1 as our first release, right? If so, the first entry in the changelog will be the v1.0.0-alpha.1 release. In other words, we won't include all tendermint-rs releases' changelog entries. For that folks can go look at the tendermint-rs changelog.
We don't necessarily need to; tendermint-rs versioning has been decoupled from Tendermint core releases, and we may well continue this with further 0.x releases. The semantic versioning of cometbft-rs needs to reflect changes in Rust API. If we release 1.0.0, but then need to introduce major or breaking changes in Rust only, not following any changes in protobufs or other CometBFT specs, our versioning will need to "run ahead" of CometBFT-go. Also, I'm not at all confident that we'd like to enshrine the current Rust APIs as 1.x, and I feel we need to iterate on it a bit, and maybe do audit and pruning of the public API like you did with CometBFT-go. |
The consensus algorithm is still named Tendermint.
CometBFT software, no Core (used to be Tendermint Core). "Tendermint" refers to the protocol.
| @@ -100,13 +100,13 @@ traits. | |||
| - RPC [core types] in golang | |||
|
|
|||
| - RPC endpoints REST interface documentation: | |||
| <https://docs.tendermint.com/v0.34/rpc/> | |||
| <https://docs.cometbft.com/v1/rpc/> | |||
There was a problem hiding this comment.
If we're going to refer to v1 docs, we should do so consistently throughout the codebase (e.g. the ABCI references in the Rust code/docs which currently incorrectly point to master).
There was a problem hiding this comment.
Yes, here I assume that we will have the v1 folder on the docs website, at the latest by the time this is released as 1.0.0.
Co-authored-by: Thane Thomson <[email protected]>
There is no "master" folder on the docs website.
The abci-harness image was used to test the terdermint-abci crate which has been removed in transition to cometbft-rs.
Remove changelog entries from tendermint-rs releases and change the epilogue to describe cometbft-rs as a fork of tendermint-rs, providing a permalink to the last revision of CHANGELOG.md before forking. This does not touch the CHANGELOG.md file itself yet; it will be updated with the next release.
Revert to Tendermint naming where it refers to the algorithm, specs, or protocol-based data structures.
Forgot to rename the directories to cometbft*
I have rebooted the |
Closes: #5
.changelog/