Skip to content

Commit

Permalink
OSS review command added to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Anna Haig committed May 30, 2023
1 parent 89d9f1f commit 4ebf4d7
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ cargo run --features tls --example search

### Proto files

- Are submoduled in [api/](api/) from [https://github.com/Iotic-Labs/api][api_remote].
- [proto/google/rpc/status.proto][google_proto_local] is included as it's a dependency.
- Are submoduled in [api/](api/) from [https://github.com/Iotic-Labs/api][api_remote].
- [proto/google/rpc/status.proto][google_proto_local] is included as it's a dependency.

### Incrementing the API version

Expand Down Expand Up @@ -68,20 +68,20 @@ Should contain a summary of the changes in [CHANGELOG.md](README.md) under the U

### Releasing

- Increment the version in [Cargo.toml][cargo_version]
- Update [README.md](README.md) and [CHANGELOG.md](CHANGELOG.md) as needed
- Commit
- Tag the commit and push the changes to `main`
- Increment the version in [Cargo.toml][cargo_version]
- Update [README.md](README.md) and [CHANGELOG.md](CHANGELOG.md) as needed
- Commit
- Tag the commit and push the changes to `main`

```bash
git push
git tag -a vX.X.X -m "vX.X.X"
git push origin vX.X.X
```

- Release\
Create a [new release][releases] containing the relevant change log.\
The [publish.yaml][publish_action] GitHub Action will pick it up and do the actual release to [crates.io][crates].
- Release\
Create a [new release][releases] containing the relevant change log.\
The [publish.yaml][publish_action] GitHub Action will pick it up and do the actual release to [crates.io][crates].

[crates_badge]: https://img.shields.io/crates/v/iotics-grpc-client.svg
[crates]: https://crates.io/crates/iotics-grpc-client
Expand All @@ -98,3 +98,10 @@ Should contain a summary of the changes in [CHANGELOG.md](README.md) under the U
[cargo_version]: https://github.com/Iotic-Labs/iotics-grpc-client-rs/blob/main/Cargo.toml#L3
[releases]: https://github.com/Iotic-Labs/iotics-grpc-client-rs/releases
[publish_action]: https://github.com/Iotic-Labs/iotics-grpc-client-rs/actions/workflows/security-audit.yml

### OSS Review

```
cargo install cargo-license
cargo license -t --avoid-build-deps --avoid-dev-deps --direct-deps-only
```

0 comments on commit 4ebf4d7

Please sign in to comment.