Skip to content

Commit

Permalink
move README; fix var
Browse files Browse the repository at this point in the history
  • Loading branch information
dougch committed Dec 20, 2024
1 parent c57b4dc commit 26c1c57
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci_rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
run: cargo test --features unstable-renegotiate

- name: Network-enabled integration tests
working-directory: ${{env.ROOT_PATH}}/standard/integration
working-directory: ${{env.STANDARD_PATH}}/integration
# no-default-features is used because network tests are hidden behind a
# default "negative" feature. This is because we don't want network tests
# invoked on the `cargo test --all-features` pattern.
Expand Down
21 changes: 18 additions & 3 deletions bindings/rust/README.md → bindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,30 @@ In order to generate rust bindings for s2n-tls, you need to have the following i
Generating rust bindings can be accomplished by running the `generate.sh` script:

```
$ ./bindings/rust/generate.sh
$ ./bindings/rust/extended/generate.sh
```

This script generates the low-level bindings in the crate `s2n-tls-sys`, which is used by the `s2n-tls` crate to provide higher-level bindings.
See [s2n-tls-sys](https://github.com/aws/s2n-tls/blob/main/bindings/rust/s2n-tls-sys/README.md) for more information on `s2n-tls-sys` crate.

## Minimum Supported Rust Version (MSRV)

`s2n-tls` will maintain a rolling MSRV (minimum supported rust version) policy of at least 6 months. The current s2n-quic version is not guaranteed to build on Rust versions earlier than the MSRV.
There are three workspaces, with slightly different MSRV policies, to keep broad support for the bindings, while allowing newer MSRV for integrations, like `s2n-tls-hyper`.

### Extended

The current MSRV for `s2n-tls`, `s2n-tls-sys` and `s2n-tls-tokio` is [1.63.0][msrv-url].

### Standard

We will maintain a rolling MSRV (minimum supported rust version) policy of at least 6 months. The current s2n-quic version is not guaranteed to build on Rust versions earlier than the MSRV.

The current MSRV for the standard workspace is [1.74.0][msrv-url].

### Rust Examples

The current MSRV for the Rust Examples workspace is [stable][msrv-url].



The current MSRV is [1.63.0][msrv-url].

0 comments on commit 26c1c57

Please sign in to comment.