Skip to content

Commit

Permalink
📝 Add release documentation in RELEASE_PROCESS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GabrielePicco authored Dec 2, 2024
1 parent 51e4e80 commit f0a98a0
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions RELEASE_PROCESS.md
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.

0 comments on commit f0a98a0

Please sign in to comment.