Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve release process #10

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ rlt for various services, such as Http, gRPC, Thrift, Database, or other customi

### Quick Start

To use `rlt`, firstly add it as a dependency:
Run `cargo add rlt` to add `rlt` as a dependency to your `Cargo.toml`:

```toml
[dependencies]
rlt = "v0.1.1-rc.1"
```
$ cargo add rlt
```

Then create your bench suite by implementing the `BenchSuite` trait.
You can use `flatten` attribute provided by `clap` to embed the predefined `BenchCli` into your own.
`flatten` attribute can be used to embed the predefined `BenchCli` into your own.

```rust
#[derive(Parser, Clone)]
Expand Down Expand Up @@ -62,7 +64,7 @@ impl BenchSuite for HttpBench {
}
```

Note that you can create a separate struct to hold the cli options for more flexibility. There is an example in [examples/http_hyper.rs](examples/http_hyper.rs).
*You can also create a separate struct to hold the cli options for more flexibility. There is an example in [examples/http_hyper.rs](examples/http_hyper.rs).*

Finally, create the main function to run the load test:

Expand Down
7 changes: 7 additions & 0 deletions release.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
allow-branch = ["improve-release"]
pre-release-replacements = [
{ file = "README.md", search = "rlt = .*", replace = "{{crate_name}} = \"{{version}}\"" },
]
pre-release-hook = ["git", "cliff", "-o", "CHANGELOG.md", "--tag", "{{version}}" ]
pre-release-commit-message = "chore: release {{crate_name}} version {{version}}"
tag-message = "chore: release {{crate_name}} version {{version}}"
Loading