Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .agents/skills/tenderdash-release/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,10 @@ Platform rollout, and required tests in the release plan.
## Prepare the reviewable release

Work in an isolated feature/release checkout at the reviewed source SHA. Preserve
unrelated work. Update `TMVersionDefault` in `version/version.go` to the chosen
version, and only the protocol versions justified above. Prepare `CHANGELOG.md`
from the reviewed changes, preserving existing release sections. Include the
unrelated work. Update `TMVersionDefault` in `version/version.go` and
`info.version` in `rpc/openapi/openapi.yaml` to the chosen version (a test in
`version/` keeps them equal), and only the protocol versions justified above.
Prepare `CHANGELOG.md` from the reviewed changes, preserving existing release sections. Include the
version/date, meaningful user-facing changes, breaking behavior and migration;
exclude already-released patches and reverted effects. Commit prefixes can help
organize the notes but cannot replace diff review. Do not regenerate old history
Expand Down
10 changes: 6 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,12 @@ make format
## Branching and PR Workflow

- `dev` is the integration branch; `master` is the latest stable Dash Platform release line.
- Select PR targets by their role and dependencies, not by sorting versioned
branch names.
- Create feature branches from integration and open PRs back into it. Stable
hotfixes branch from `master` and are forward-ported to integration.
- Do all development on `dev`: create feature branches from `origin/dev` and
open PRs into `dev`. The only exception is a stable hotfix, which branches
from `master` and is forward-ported to `dev`.
- Versioned `vX.Y-dev` branches (e.g. `v1.8-dev`, `v1.9-dev`) are retired. Never
branch from, target, or compare against them, even if one still exists on
the remote.
- Keep commits focused and well-described.
- Use conventional commit format for commit and PR titles.
- Do not manually edit or generate `CHANGELOG.md` for development changes.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The useful distinction is each branch's role:

Target `dev` for ordinary integration PRs. Select another target explicitly for
a release, hotfix or dependent change, following [RELEASES.md](RELEASES.md).
Choose by the branch's role rather than sorting historical versioned names.
Versioned `vX.Y-dev` branches (e.g. `v1.9-dev`) are retired; never target them.

A PR that depends on another open PR can target its parent feature branch.
Describe the dependency and keep its diff focused; after the parent lands,
Expand Down
4 changes: 2 additions & 2 deletions rpc/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ info:

ws ws://localhost:26657/websocket
> { "jsonrpc": "2.0", "method": "subscribe", "params": ["tm.event='NewBlock'"], "id": 1 }
version: "v1.8-dev"
version: "2.0.0-dev.1"
license:
name: Apache 2.0
url: https://github.com/dashpay/tenderdash/blob/v1.8-dev/LICENSE
url: https://github.com/dashpay/tenderdash/blob/master/LICENSE
servers:
- url: http://localhost:26657
description: Interact with the Tenderdash RPC locally on your device
Expand Down
4 changes: 2 additions & 2 deletions scripts/prepare-docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def rewrite_link(match, source, root, source_ref):
return prefix + replacement


def prepare(root=ROOT, source_ref="v1.8-dev"):
def prepare(root=ROOT, source_ref="dev"):
root = root.resolve()
summary = (root / "book/SUMMARY.md").read_text()
listed = set(re.findall(r"\]\(([^)]+\.md)\)", summary))
Expand Down Expand Up @@ -99,7 +99,7 @@ def prepare(root=ROOT, source_ref="v1.8-dev"):
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument(
"--source-ref",
default="v1.8-dev",
default="dev",
help="Git ref for links to repository source files",
)
args = parser.parse_args()
Expand Down
8 changes: 4 additions & 4 deletions scripts/release/plan.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,17 @@ def release_plan(repo, mode, source, baseline):
if version and tuple(map(int, version.groups())) > baseline_version:
raise ValueError(f"newer reachable stable tag {tag}; review the baseline")

integration = (
"origin/dev" if exists(repo, "refs/remotes/origin/dev") else "origin/v1.8-dev"
)
integration = "origin/dev"
if not exists(repo, "refs/remotes/origin/dev"):
raise ValueError("origin/dev not found; fetch the integration branch")
integration_sha = git(repo, "rev-parse", "--verify", f"{integration}^{{commit}}")
stable_sha = git(repo, "rev-parse", "--verify", "origin/master^{commit}")
if mode == "next":
if not ancestor(repo, source_sha, integration_sha):
raise ValueError(
"next release source must be on the fetched integration lineage"
)
target = "dev" if integration == "origin/dev" else "v1.8-dev"
target = "dev"
else:
if not ancestor(repo, stable_sha, source_sha):
raise ValueError("hotfix source must descend from origin/master")
Expand Down
4 changes: 2 additions & 2 deletions scripts/release/test_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ def test_unreachable_baseline_is_rejected(self):
self.git("tag", "v9.0.0")
self.assertIn("ancestor", self.plan("--baseline", "v9.0.0", success=False))

def test_transition_uses_v18_not_highest_version(self):
def test_versioned_dev_branches_never_replace_missing_dev(self):
self.git("update-ref", "-d", "refs/remotes/origin/dev")
self.git("update-ref", "refs/remotes/origin/v1.8-dev", self.dev)
self.git("update-ref", "refs/remotes/origin/v9.0-dev", "origin/master")
self.assertEqual(self.plan()["integration"], "origin/v1.8-dev")
self.assertIn("origin/dev", self.plan(success=False))

def test_backport_evidence_identifies_patch_already_on_stable(self):
self.git("checkout", "-q", "-b", "stable", "origin/master")
Expand Down
16 changes: 8 additions & 8 deletions scripts/tests/test_prepare_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ def write(self, path, content):
def test_stages_sources_assets_and_rpc_without_changing_originals(self):
original = (self.root / "docs/README.md").read_text()
self.write("docs/image.svg", "<svg/>")
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")
staged = self.root / "book/src"
welcome = (staged / "docs/README.md").read_text()
self.assertNotIn("Old metadata", welcome)
self.assertIn("[Guides](docs/index.md)", (staged / "README.md").read_text())
self.assertIn("[Protocol](../spec/consensus.md#rounds)", welcome)
self.assertIn(
"https://github.com/dashpay/tenderdash/blob/v1.8-dev/internal/state.go",
"https://github.com/dashpay/tenderdash/blob/dev/internal/state.go",
welcome,
)
self.assertIn(
Expand Down Expand Up @@ -79,29 +79,29 @@ def test_ignores_old_vuepress_dependencies_and_output(self):
for directory in ("node_modules", ".vuepress", "dist", "_build", "spec"):
(self.root / "docs" / directory).mkdir()
self.write(f"docs/{directory}/stale.md", "# Old build output\n")
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")
for directory in ("node_modules", ".vuepress", "dist", "_build", "spec"):
self.assertFalse((self.root / "book/src/docs" / directory).exists())

def test_strips_metadata_without_final_newline(self):
self.write("docs/README.md", "---\norder: false\n---")
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")
self.assertEqual((self.root / "book/src/docs/README.md").read_text(), "")

def test_rejects_unlisted_chapter(self):
self.write("spec/new-protocol.md", "# New protocol\n")
with self.assertRaisesRegex(ValueError, "new-protocol.md"):
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")

def test_rejects_missing_chapter(self):
(self.root / "spec/consensus.md").unlink()
with self.assertRaisesRegex(ValueError, "consensus.md"):
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")

def test_removes_stale_staged_files(self):
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")
self.write("book/src/stale.md", "# Removed\n")
self.module.prepare(self.root, "v1.8-dev")
self.module.prepare(self.root, "dev")
self.assertFalse((self.root / "book/src/stale.md").exists())


Expand Down
21 changes: 21 additions & 0 deletions version/version_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package version

import (
"os"
"path/filepath"
"strconv"
"testing"

"github.com/stretchr/testify/require"
)

// The release process bumps TMVersionDefault; the RPC OpenAPI document must
// advertise the same version.
func TestOpenAPIVersionMatchesTMVersionDefault(t *testing.T) {
spec, err := os.ReadFile(filepath.Join("..", "rpc", "openapi", "openapi.yaml"))
require.NoError(t, err)

want := "\n version: " + strconv.Quote(TMVersionDefault) + "\n"
require.Contains(t, string(spec), want,
"rpc/openapi/openapi.yaml info.version must be %q", TMVersionDefault)
}
Loading