Skip to content

Commit bce55b6

Browse files
authored
Revert "Repair upstream GitHub references for SDK v0.55 and CometBFT v0.40" (#336)
This reverts commit f84f83b.
1 parent f84f83b commit bce55b6

187 files changed

Lines changed: 783 additions & 2514 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/skills/pr-description/SKILL.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

.claude/skills/update-stale-refs/SKILL.md

Lines changed: 0 additions & 144 deletions
This file was deleted.

CLAUDE.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,17 +154,13 @@ Two things are version-pinned and do not follow the freeze on their own:
154154
grep -rn 'description: "Version: v' sdk/next --include='*.mdx'
155155
```
156156

157-
**GitHub links pinned to the previous release branch.** Pages link into the product repo at `release/v0.<N>.x` (SDK) or `v0.<N>.x` (CometBFT), and those refs keep pointing at the old version. Use the checker rather than a find-and-replace:
157+
**GitHub links pinned to the previous release branch.** Pages link into the product repo at `release/v0.<N>.x` (SDK) or `v0.<N>.x` (CometBFT), and those refs keep pointing at the old version:
158158

159159
```bash
160-
node scripts/versioning/check-github-refs.js --product <product> --targets next --json /tmp/flags.json
160+
grep -rhoE 'github\.com/cosmos/cosmos-sdk/(blob|tree)/release/v[0-9.]+x' <product>/next --include='*.mdx' | sort | uniq -c
161161
```
162162

163-
Review the report, then apply the safe rewrites with `--fix`. It bumps only what it can prove is safe and flags the rest.
164-
165-
Do not blind-replace these by hand. Pinned tags and commit SHAs are deliberate historical citations, and bumping a ref under a `#L` line anchor can leave the link working while pointing at unrelated code. See the GitHub link section in [`scripts/versioning/CLAUDE.md`](scripts/versioning/CLAUDE.md) for the rules and the measured failure rates.
166-
167-
Hand the `--json` output to the [`update-stale-refs`](.claude/skills/update-stale-refs/SKILL.md) skill, which decides whether a flagged link means the page's prose needs a correction.
163+
Do not blind-replace these. Pinned tags and commit SHAs are deliberate historical citations, and bumping a ref under a `#L` line anchor can leave the link working while pointing at unrelated code. See the GitHub link section in [`scripts/versioning/CLAUDE.md`](scripts/versioning/CLAUDE.md) for the rules and the measured failure rates.
168164

169165
A stale ref is often a symptom rather than the problem. A link that 404s at its current ref usually means the prose describes something upstream deleted, so check what the page claims before repointing the URL.
170166

cometbft/latest/docs/app-dev/Using-ABCI-CLI.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ purposes.
6464
We'll start a kvstore application, which was installed at the same time as
6565
`abci-cli` above. The kvstore just stores transactions in a Merkle tree. Its
6666
code can be found
67-
[here](https://github.com/cometbft/cometbft/blob/v0.40.x/abci/example/kvstore/kvstore.go).
67+
[here](https://github.com/cometbft/cometbft/blob/v0.38.x/abci/example/kvstore/kvstore.go).
6868
6969
Start the application by running:
7070
@@ -104,7 +104,7 @@ response.
104104
105105
The server may be generic for a particular language, and we provide a
106106
[reference implementation in
107-
Golang](https://github.com/cometbft/cometbft/tree/v0.40.x/abci/server). See the
107+
Golang](https://github.com/cometbft/cometbft/tree/v0.38.x/abci/server). See the
108108
[list of other ABCI implementations](https://github.com/tendermint/awesome#ecosystem) for servers in
109109
other languages.
110110

cometbft/latest/docs/core/Running-in-production.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ proposing the next block).
369369

370370
By default, CometBFT checks whether a peer's address is routable before
371371
saving it to the address book. The address is considered as routable if the IP
372-
is [valid and within allowed ranges](https://github.com/cometbft/cometbft/blob/v0.40.x/p2p/netaddress.go#L259).
372+
is [valid and within allowed ranges](https://github.com/cometbft/cometbft/blob/v0.38.x/p2p/netaddress.go#L258).
373373

374374
This may not be the case for private or local networks, where your IP range is usually
375375
strictly limited and private. In that case, you need to set `addr_book_strict`

cometbft/latest/docs/core/Subscribing-to-events-via-Websocket.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Prior to version `v0.38.x`, floats were not supported as query parameters.
6363
When the validator set changes, the ValidatorSetUpdates event is published. The
6464
event carries a list of pubkey/power pairs. The list is the same as what
6565
CometBFT receives from the ABCI application (see the [EndBlock
66-
section](https://github.com/cometbft/cometbft/blob/v0.40.x/spec/abci/abci++_methods.md#endblock) in
66+
section](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#endblock) in
6767
the ABCI spec).
6868

6969
Response:

cometbft/latest/docs/core/Using-CometBFT.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ cometbft testnet --help
3939

4040
The `genesis.json` file in `$CMTHOME/config/` defines the initial
4141
CometBFT state upon genesis of the blockchain ([see
42-
definition](https://github.com/cometbft/cometbft/blob/v0.40.x/types/genesis.go)).
42+
definition](https://github.com/cometbft/cometbft/blob/v0.38.x/types/genesis.go)).
4343

4444
#### Fields
4545

@@ -49,7 +49,7 @@ definition](https://github.com/cometbft/cometbft/blob/v0.40.x/types/genesis.go))
4949
chain IDs, you will have a bad time. The ChainID must be less than 50 symbols.
5050
- `initial_height`: Height at which CometBFT should begin. If a blockchain is conducting a network upgrade,
5151
starting from the stopped height brings uniqueness to previous heights.
52-
- `consensus_params` ([see spec](https://github.com/cometbft/cometbft/blob/v0.40.x/spec/core/data_structures.md#consensusparams))
52+
- `consensus_params` ([see spec](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/core/data_structures.md#consensusparams))
5353
- `block`
5454
- `max_bytes`: Max block size, in bytes.
5555
- `max_gas`: Max gas per block.
@@ -71,7 +71,7 @@ definition](https://github.com/cometbft/cometbft/blob/v0.40.x/types/genesis.go))
7171
application will initialize the validator set upon `InitChain`.
7272
- `pub_key`: The first element specifies the key type,
7373
using the declared `PubKeyName` for the adopted
74-
[key type](https://github.com/cometbft/cometbft/blob/v0.40.x/crypto/ed25519/ed25519.go#L36).
74+
[key type](https://github.com/cometbft/cometbft/blob/v0.38.x/crypto/ed25519/ed25519.go#L36).
7575
The second element are the pubkey bytes.
7676
- `power`: The validator's voting power.
7777
- `name`: Name of the validator (optional).
@@ -565,7 +565,7 @@ library will deny making connections to peers with the same IP address.
565565
### Upgrading
566566

567567
See the
568-
[UPGRADING.md](https://github.com/cometbft/cometbft/blob/v0.40.x/UPGRADING.md)
568+
[UPGRADING.md](https://github.com/cometbft/cometbft/blob/v0.38.x/UPGRADING.md)
569569
guide. You may need to reset your chain between major breaking releases.
570570
Although, we expect CometBFT to have fewer breaking releases in the future
571571
(especially after the 1.0 release).

cometbft/latest/docs/core/block-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ component—that's the best place to get started.
1414

1515
To dig deeper, check out the [types package documentation][types].
1616

17-
[data_structures]: https://github.com/cometbft/cometbft/blob/v0.40.x/spec/core/data_structures.md
17+
[data_structures]: https://github.com/cometbft/cometbft/blob/v0.38.x/spec/core/data_structures.md
1818
[types]: https://pkg.go.dev/github.com/cometbft/cometbft/types

0 commit comments

Comments
 (0)