-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Add release documentation in RELEASE_PROCESS.md
- Loading branch information
1 parent
51e4e80
commit f0a98a0
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
### Release Process | ||
|
||
1. **Create a Release Branch** | ||
Create a new branch named `release/v*.*.*`. | ||
|
||
2. **Update Version in `Cargo.toml`** | ||
Increment the version number in the `Cargo.toml` file according to the release type (major, minor, or patch). | ||
|
||
3. **Align Versions** | ||
Run the `./version-align.sh` script. This will: | ||
- Update the version of all internal crates and npm packages. | ||
- Generate the updated crates. | ||
|
||
4. **Continuous Integration (CI) Testing** | ||
- The CI pipeline will test the packages and crate deployment in a dry-run mode. | ||
- Ensure all tests pass successfully. | ||
|
||
5. **Merge and Deploy** | ||
- Merge the release branch into `main` after verifying all tests pass. | ||
- Create a new Release on GitHub. This will trigger the actual deployment process for the crates and packages. | ||
|
||
6. **Post-Deployment** | ||
Verify that the deployment is complete and the crates and packages are available as expected. |