Update docs and CI references for `v0.38.x` backport branch by thanethomson · Pull Request #596 · cometbft/cometbft

thanethomson · 2023-03-28T00:15:42Z

Partially addresses #33 (specifically #595), following the backport branch creation steps in https://github.com/cometbft/cometbft/blob/main/RELEASES.md#creating-a-backport-branch

Can be reviewed commit by commit.

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>

jmalicevic · 2023-03-28T14:04:24Z

.github/workflows/fuzz-nightly.yml

  pull_request:
-    branches: [main]
+    branches:
+      - v0.38.x


I assume the difference in the notaion has no impact?

No, YAML allows one to represent arrays both ways. We tend to use this convention more than the [main] one though, so I thought I'd adapt it to the conventional way.

lasarojc

Some changes are not needed and should be done on main instead.
Some of the links replaced could be made relative, on main, so there is no need to update them in future forks.
Other than that, LGTM

lasarojc · 2023-03-28T13:16:02Z

.github/workflows/build.yml

 name: Build
 # Tests runs different tests (test_abci_apps, test_abci_cli, test_apps)
-# This workflow runs on every push to main or release branch and  every pull requests
+# This workflow runs on every push to v0.38.x and every pull request


Can we replace for a generic comment instead? This way this will not have to be changed on every new branch.

should be done in main, rather.

Will do that in a follow-up PR 👍

lasarojc · 2023-03-28T13:55:45Z

.github/workflows/lint.yml

  push:
    branches:
-      - main
+      - v0.38.x


could we use - 'v*.*.*' on main, to simplify these releases?

lasarojc · 2023-03-28T14:02:23Z

consensus/state.go

 	const timeIota = time.Millisecond
 	// TODO: We should remove next line in case we don't vote for v in case cs.ProposalBlock == nil,
-	// even if cs.LockedBlock != nil. See https://github.com/cometbft/cometbft/tree/main/spec/.
+	// even if cs.LockedBlock != nil. See https://github.com/cometbft/cometbft/tree/v0.38.x/spec/.


Suggested change

// even if cs.LockedBlock != nil. See https://github.com/cometbft/cometbft/tree/v0.38.x/spec/.

// even if cs.LockedBlock != nil.

// See the BFT time spec https://github.com/cometbft/cometbft/blob/v0.38.x/spec/consensus/bft-time.md.

lasarojc · 2023-03-28T14:02:39Z

consensus/state.go

 		// See the BFT time spec
-		// https://github.com/cometbft/cometbft/blob/main/spec/consensus/bft-time.md
+		// https://github.com/cometbft/cometbft/blob/v0.38.x/spec/consensus/bft-time.md


Suggested change

// See the BFT time spec

// https://github.com/cometbft/cometbft/blob/main/spec/consensus/bft-time.md

// https://github.com/cometbft/cometbft/blob/v0.38.x/spec/consensus/bft-time.md

lasarojc · 2023-03-28T14:03:06Z

consensus/state.go

 		}

-		var pbb = new(cmtproto.Block)
+		pbb := new(cmtproto.Block)


this one should be done in main and backported.

lasarojc · 2023-03-28T14:30:59Z

rpc/core/evidence.go

-	ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) {
-
+	ev types.Evidence,
+) (*ctypes.ResultBroadcastEvidence, error) {


lasarojc · 2023-03-28T14:31:20Z

rpc/core/mempool.go

 		Total:      env.Mempool.Size(),
 		TotalBytes: env.Mempool.SizeBytes(),
-		Txs:        txs}, nil
+		Txs:        txs,


lasarojc · 2023-03-28T15:09:14Z

rpc/openapi/openapi.yaml

  license:
    name: Apache 2.0
-    url: https://github.com/cometbft/cometbft/blob/main/LICENSE
+    url: https://github.com/cometbft/cometbft/blob/v0.38.x/LICENSE


the license shouldn't change. the link could stay as main.

lasarojc · 2023-03-28T15:17:51Z

types/block.go

-	var (
-		commit = new(Commit)
-	)
+	commit := new(Commit)


not needed. do it in main.

lasarojc · 2023-03-28T15:19:21Z

spec/p2p/v0.34/README.md

 Existing documentation referring to the p2p layer:

- <https://github.com/cometbft/cometbft/tree/main/spec/p2p>: p2p-related
+- <https://github.com/cometbft/cometbft/tree/v0.38.x/spec/p2p>: p2p-related


should we make these links relative, so they get locked by branch automatically?

I think we need a bigger effort to make as many of the docs' links relative as we can.

thanethomson added 5 commits March 27, 2023 20:02

Update README for v0.38.x and fix test/linter URLs

5195a21

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Update GitHub links from main to v0.38.x

f64c17c

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Replace docs.cometbft.com references from main to v0.38.x

e71f8ea

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Update RELEASES.md to include OpenAPI and docs site instructions

1be898a

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Update OpenAPI version

7502a1d

Signed-off-by: Thane Thomson <connect@thanethomson.com>

thanethomson requested review from a team as code owners March 28, 2023 00:15

thanethomson mentioned this pull request Mar 28, 2023

Prepare v0.38.x backport branch #595

Closed

5 tasks

thanethomson changed the title ~~Prepare documentation references for v0.38.x backport branch~~ Update docs references for v0.38.x backport branch Mar 28, 2023

thanethomson modified the milestone: 2023-Q1 Mar 28, 2023

thanethomson changed the title ~~Update docs references for v0.38.x backport branch~~ Update docs and CI references for v0.38.x backport branch Mar 28, 2023

thanethomson added 2 commits March 28, 2023 07:35

ci: Prepare v0.38.x branch

a0eca37

Signed-off-by: Thane Thomson <connect@thanethomson.com>

Fix typo

8f4438a

Signed-off-by: Thane Thomson <connect@thanethomson.com>

thanethomson mentioned this pull request Mar 28, 2023

Update CI and root docs on main for v0.38 release #597

Merged

3 tasks

jmalicevic reviewed Mar 28, 2023

View reviewed changes

jmalicevic approved these changes Mar 28, 2023

View reviewed changes

thanethomson merged commit b0ea374 into v0.38.x Mar 28, 2023

thanethomson deleted the thane/595-prep-v0.38.x-docs branch March 28, 2023 14:40

lasarojc approved these changes Mar 28, 2023

View reviewed changes

faddat mentioned this pull request Oct 15, 2024

chore: use latest cometbft-db in v0.38.x #4296

Closed

3 tasks

	// even if cs.LockedBlock != nil. See https://github.com/cometbft/cometbft/tree/v0.38.x/spec/.
	// even if cs.LockedBlock != nil.
	// See the BFT time spec https://github.com/cometbft/cometbft/blob/v0.38.x/spec/consensus/bft-time.md.

	// See the BFT time spec
	// https://github.com/cometbft/cometbft/blob/main/spec/consensus/bft-time.md
	// https://github.com/cometbft/cometbft/blob/v0.38.x/spec/consensus/bft-time.md

Conversation

thanethomson commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lasarojc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

thanethomson commented Mar 28, 2023 •

edited

Loading