Skip to content

Commit c22e9da

Browse files
authored
Merge pull request #1390 from o1-labs/dw/update-doc-release
Website/release: add checklist + fix release tag
2 parents 9870961 + 1cc11ed commit c22e9da

File tree

2 files changed

+55
-4
lines changed

2 files changed

+55
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6262
[#1340](https://github.com/o1-labs/mina-rust/pull/1340),
6363
[#2981ecf](https://github.com/o1-labs/mina-rust/commit/2981ecf9519517f69947838407a09ea96f7ff293),
6464
[#1e9f33f](https://github.com/o1-labs/mina-rust/commit/1e9f33f125dcaab36d9dd2dc17759e3476bc36e8))
65+
- **Documentation**: add release communication checklist
66+
([#1390](https://github.com/o1-labs/mina-rust/pull/1390))
6567

6668
### Changed
6769

website/docs/appendix/release-process.mdx

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,55 @@ it to `main`, and then tagging from `main`.
6161
- Documentation updates
6262
- No new features
6363

64+
## Release Communication Checklist
65+
66+
### Slack/Communication Template
67+
68+
Copy and paste this checklist when announcing a release in progress:
69+
70+
```markdown
71+
## 🚀 Release in Progress: vX.Y.Z
72+
73+
**Release Manager:** @[your-name] **Target Date:** [date] **Type:** [ ] Major [
74+
] Minor [ ] Patch
75+
76+
### Pre-Release
77+
78+
- [ ] Develop branch stability verified
79+
- [ ] CHANGELOG.md updated
80+
- [ ] Version compatibility checked
81+
- [ ] Release branch created (if major/minor)
82+
- [ ] Version numbers updated in Cargo.toml files
83+
84+
### Release Process
85+
86+
- [ ] PR created from release branch to main
87+
- [ ] CI tests passing
88+
- [ ] Required approvals obtained
89+
- [ ] PR merged to main
90+
- [ ] Git tag created and pushed
91+
- [ ] Docker images building (automated)
92+
- [ ] GitHub release draft created
93+
94+
### Verification
95+
96+
- [ ] Docker images available on Docker Hub
97+
- [ ] Multi-arch images verified (amd64/arm64)
98+
- [ ] CI pipeline completed successfully
99+
- [ ] GitHub release published
100+
101+
### Post-Release
102+
103+
- [ ] Main branch merged back to develop
104+
- [ ] Documentation updated
105+
- [ ] Release announced in #announcements
106+
- [ ] Known issues documented (if any)
107+
108+
**Tracking:** [Link to PR/Issue] **Status:** 🟡 In Progress
109+
110+
_Updates will be posted in this thread_
111+
```
112+
64113
## Pre-Release Checklist
65114

66115
1. **Verify develop branch stability**
@@ -118,17 +167,17 @@ reviewed.
118167

119168
**Images will be available as:**
120169

121-
- `o1labs/mina-rust:release/v1.5.0`
122-
- `o1labs/mina-rust-frontend:release/v1.5.0`
170+
- `o1labs/mina-rust:v1.5.0`
171+
- `o1labs/mina-rust-frontend:v1.5.0`
123172

124173
**To test locally:** See
125174
[Docker Images documentation](../developers/docker-images) for complete usage
126175
instructions.
127176

128177
```bash
129178
# Example usage
130-
docker pull o1labs/mina-rust:release/v1.5.0
131-
docker run -p 8302:8302 o1labs/mina-rust:release/v1.5.0
179+
docker pull o1labs/mina-rust:v1.5.0
180+
docker run -p 8302:8302 o1labs/mina-rust:v1.5.0
132181
```
133182

134183
:::

0 commit comments

Comments
 (0)