-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixes # ### What Changed? This PR adds a release document, intended as a checklist that maintainers go through to make a new release. ### Reviewer Checklist - [ ] New features are tested and documented - [ ] PR has one of the `changelog-X` labels (if applies) - [ ] Code deprecates any old functionality before removing it
- Loading branch information
1 parent
8c647e6
commit 1095aff
Showing
2 changed files
with
29 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
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,28 @@ | ||
# Release Process | ||
|
||
> [!WARNING] | ||
> 🏗️ This document is a Work-in-Progress 🚧 | ||
- [ ] Go to the "Draft a new release" page ([link](https://github.com/Layr-Labs/eigensdk-rs/releases/new)). | ||
|
||
- [ ] Generate a new tag for the release by pressing on "Choose a tag", writing the version number `vX.Y.Z`, and pressing on "Create new tag: `vX.Y.Z`". | ||
|
||
- [ ] Adjust the release target or previous tag if needed. | ||
|
||
- [ ] Press on "Generate release notes" to autogenerate the changelog. | ||
|
||
- [ ] Verify that there aren't any missing commits in the autogenerated changelog. | ||
|
||
- [ ] Create a new branch for the release. | ||
|
||
- [ ] Merge the autogenerated changelog with the change descriptions on the `CHANGELOG.md` changelog's "[Unreleased]" section. | ||
|
||
- [ ] Add any missing descriptions to the changelog items. It's recommended that every item that's not in "Documentation" or "Other Changes" has a description of what changed and instructions on how to migrate. You can encounter examples in previous changelog entries. | ||
|
||
- [ ] Bump the version in the workspace's `Cargo.toml`, careful of following [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
- [ ] Commit the changelog and `Cargo.toml` changes and submit a PR. | ||
|
||
- [ ] Sync the release draft description with the changelog and save the draft. | ||
|
||
- [ ] Once the draft is reviewed, the PR is merged, and the CI run on the release branch succeeds, publish the release. |