Skip to content

Commit

Permalink
Merge branch 'dev' - release v0.1.3
Browse files Browse the repository at this point in the history
Signed-off-by: mimir-d <[email protected]>
  • Loading branch information
mimir-d committed Oct 14, 2024
2 parents 8953fa0 + c741eee commit c7ae833
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ jobs:
cargo release \
publish \
--all-features \
--allow-branch HEAD \
--allow-branch main \
--no-confirm \
--execute
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ocptv"
version = "0.1.2"
version = "0.1.3"
description = "Strongly typed Rust API for OCPTV output"
authors = ["OCP Test & Validation Project"]
keywords = ["ocptv", "hardware", "validation"]
Expand Down
5 changes: 3 additions & 2 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
To make a new release, and publish to crates.io, a new tagged commit needs to exist on the `main` branch. This is done with a simple merge from the `dev` branch. **Do not** push any other kinds of commits to the `main` branch.

Steps:
1. bump the version. Will need [`cargo-release`](https://crates.io/crates/cargo-release) crate. Example here bumps the *patch* version.
1. bump the version. Will need [`cargo-release`](https://crates.io/crates/cargo-release) crate. Example here bumps the *patch* version (see [cargo semver](https://doc.rust-lang.org/cargo/reference/semver.html) when deciding which version number to bump).
```bash
$ git checkout dev
$ cargo release version patch --execute
$ cargo release version patch --execute # also note to update the readme
$ cargo release changes # note any changelog to add to the commit, or manually craft it
$ git add .
$ git commit
Expand All @@ -37,5 +37,6 @@ $ cargo release tag --sign-tag --execute
4. push with tags
```bash
$ git checkout main
$ git push
$ git push --tags
```
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# ocp-diag-core-rust

[![Crates.io Version](https://img.shields.io/crates/v/ocptv)](https://crates.io/crates/ocptv)
[![codecov](https://codecov.io/github/opencomputeproject/ocp-diag-core-rust/graph/badge.svg?token=IJOG0T8XZ3)](https://codecov.io/github/opencomputeproject/ocp-diag-core-rust)
[![GitHub License](https://img.shields.io/github/license/opencomputeproject/ocp-diag-core-rust)](https://github.com/opencomputeproject/ocp-diag-core-rust/blob/dev/LICENSE)

The **OCP Test & Validation Initiative** is a collaboration between datacenter hyperscalers having the goal of standardizing aspects of the hardware validation/diagnosis space, along with providing necessary tooling to enable both diagnostic developers and executors to leverage these interfaces.

Expand All @@ -27,7 +29,7 @@ For general usage, the following steps should be sufficient to get the latest st

```toml
[dependencies]
ocptv = "0.1.0"
ocptv = "~0.1"
```

To use the bleeding edge instead of the stable version, the dependecies section should be modified like this:
Expand Down

0 comments on commit c7ae833

Please sign in to comment.