Skip to content

Commit 3718a4b

Browse files
committed
document release steps for protocol repo
1 parent faf3144 commit 3718a4b

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

pages/dev/_meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@
1010
"rpc": "RPC access",
1111
"ibc": "Testing IBC",
1212
"abci-events": "Querying ABCI events",
13-
"dev-env": "Developer environment"
13+
"dev-env": "Developer environment",
14+
"release": "Releasing"
1415
}

pages/dev/release.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Cutting a new release
2+
3+
## Protocol repo release
4+
5+
When a new version is ready for shipping in the [protocol repo],
6+
follow these steps to release it:
7+
8+
1. Edit branch protections to temporarily allow pushes to `main`
9+
2. Check out main branch locally, make sure it's up to date.
10+
3. Run `cargo release --no-publish --execute 1.2.3` where `1.2.3` is the version.
11+
4. `git push origin main && git push origin v1.2.3`, again substituting the real version number.
12+
5. Re-enable branch protections.
13+
14+
It'll take ~30m for all the release workflows to run, including building binaries and publishing crates.
15+
16+
[protocol repo]: https://github.com/penumbra-zone/penumbra

0 commit comments

Comments
 (0)