Skip to content

Commit c1cd613

Browse files
committed
add release instructions
1 parent 5be43ef commit c1cd613

2 files changed

Lines changed: 36 additions & 11 deletions

File tree

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,26 @@
22
This repository is home to Jito's on-chain programs that enable MEV collection and MEV sharing with SOL stakers; additionally
33
we may host useful on-chain program reference implementations here.
44

5-
## Gitflow
6-
This repository is declared as a submodule in the `jito-solana` client. In order for that to work the `Solana`
7-
crates declared in this repo must point to the `jito-solana` declaring this as a submodule. The `Anchor` dependencies
8-
must also point to the local path where `anchor` resides as a submodule within `jito-solana`. This is due to dependency
9-
version issues. With that said, `jito-solana` declares a dependency on the `submodule` branch found in this repository.
10-
This gitflow for this repo is as follows:
11-
- Create a PR against `master`
12-
- Merge PR
13-
- `git cherry-pick` your new commits into `submodule`
14-
- push `submodule`
15-
-
5+
## Version Management
6+
7+
This project uses `cargo-release` for version management. The release process is configured to work with version branches (e.g., `v3.0.x`).
8+
9+
### Prerequisites for Release
10+
11+
1. **Install cargo-release** (if not already installed):
12+
```bash
13+
cargo install cargo-release
14+
```
15+
16+
### Release Process
17+
18+
1. **Run the release command**:
19+
```bash
20+
cargo release patch --execute
21+
```
22+
23+
This will:
24+
- Bump the version number
25+
- Create a git tag
26+
- Push changes and tags
27+
- Follow the configuration in `release.toml`

release.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Cargo Release Configuration
2+
3+
allow-branch = ["master"]
4+
publish = false
5+
release = true
6+
sign-tag = true
7+
sign-commit = true
8+
tag = true
9+
push = true
10+
11+
# Use workspace version and create single tag
12+
shared-version = true
13+
tag-name = "v{{version}}"

0 commit comments

Comments
 (0)