Skip to content

Commit f0a98a0

Browse files
📝 Add release documentation in RELEASE_PROCESS.md
1 parent 51e4e80 commit f0a98a0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

RELEASE_PROCESS.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Release Process
2+
3+
1. **Create a Release Branch**
4+
Create a new branch named `release/v*.*.*`.
5+
6+
2. **Update Version in `Cargo.toml`**
7+
Increment the version number in the `Cargo.toml` file according to the release type (major, minor, or patch).
8+
9+
3. **Align Versions**
10+
Run the `./version-align.sh` script. This will:
11+
- Update the version of all internal crates and npm packages.
12+
- Generate the updated crates.
13+
14+
4. **Continuous Integration (CI) Testing**
15+
- The CI pipeline will test the packages and crate deployment in a dry-run mode.
16+
- Ensure all tests pass successfully.
17+
18+
5. **Merge and Deploy**
19+
- Merge the release branch into `main` after verifying all tests pass.
20+
- Create a new Release on GitHub. This will trigger the actual deployment process for the crates and packages.
21+
22+
6. **Post-Deployment**
23+
Verify that the deployment is complete and the crates and packages are available as expected.

0 commit comments

Comments
 (0)