Skip to content

e-h-bus: Add MSRV notice and prepare 0.1.0-alpha.0 release #400

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

Merged
merged 3 commits into from
Aug 17, 2022
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
32 changes: 32 additions & 0 deletions .github/workflows/ci-bus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
on:
push:
branches: [ staging, trying, master ]
pull_request:

name: CI Bus

env:
RUSTFLAGS: '--deny warnings'

jobs:
ci-linux-bus:
runs-on: ubuntu-latest
strategy:
matrix:
rust: [nightly]
TARGET: [x86_64-unknown-linux-gnu, thumbv6m-none-eabi, thumbv7m-none-eabi]

steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ matrix.rust }}
target: ${{ matrix.TARGET }}
override: true
- run: cargo check --target=${{ matrix.TARGET }}
working-directory: embedded-hal-bus

- run: cargo test --target=${{ matrix.TARGET }}
if: contains(matrix.TARGET, 'linux')
working-directory: embedded-hal-bus
19 changes: 19 additions & 0 deletions .github/workflows/clippy-bus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
on:
push:
branches: [ staging, trying, master ]
pull_request:

name: Clippy check
jobs:
clippy_check-bus:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
components: clippy
- run: cargo clippy
working-directory: embedded-hal-bus
5 changes: 2 additions & 3 deletions docs/msrv.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ that may change in any new patch release.

## How the MSRV will be upgraded

For `embedded-hal`, we do not consider upgrading the MSRV a strictly breaking change as defined by
For this library, we do not consider upgrading the MSRV a strictly breaking change as defined by
[SemVer](https://semver.org).

We follow these rules when upgrading it:
Expand All @@ -23,8 +23,7 @@ For example:

For a given `x.y.z` release, we may upgrade the MSRV on `x` and `y` releases but not on `z` releases.

If your MSRV upgrade policy differs from this, you are advised to specify the
`embedded-hal` dependency in your `Cargo.toml` accordingly.
If your MSRV upgrade policy differs from this, you are advised to specify the dependency in your `Cargo.toml` accordingly.

See the [Rust Embedded Working Group MSRV RFC](https://github.com/rust-embedded/wg/blob/master/rfcs/0523-msrv-2020.md)
for more background information and reasoning.
9 changes: 9 additions & 0 deletions embedded-hal-bus/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

...

## [v0.1.0-alpha.0] - 2022-08-17

First release to crates.io

[Unreleased]: https://github.com/rust-embedded/embedded-hal/compare/embedded-hal-bus-v0.1.0-alpha.0...HEAD
[v0.1.0-alpha.0]: https://github.com/rust-embedded/embedded-hal/tree/embedded-hal-bus-v0.1.0-alpha.0
2 changes: 1 addition & 1 deletion embedded-hal-bus/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ license = "MIT OR Apache-2.0"
name = "embedded-hal-bus"
readme = "README.md"
repository = "https://github.com/rust-embedded/embedded-hal"
version = "0.1.0-alpha.1"
version = "0.1.0-alpha.0"

[dependencies]
embedded-hal = { version = "=1.0.0-alpha.8", path = ".." }
8 changes: 4 additions & 4 deletions embedded-hal-bus/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[![crates.io](https://img.shields.io/crates/d/embedded-hal-bus.svg)](https://crates.io/crates/embedded-hal-bus)
[![crates.io](https://img.shields.io/crates/v/embedded-hal-bus.svg)](https://crates.io/crates/embedded-hal-bus)
[![Documentation](https://docs.rs/embedded-hal-bus/badge.svg)](https://docs.rs/embedded-hal-bus)
<!--
![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.54+-blue.svg)
-->

# `embedded-hal-bus`

Expand All @@ -26,12 +24,14 @@ This project is developed and maintained by the [HAL team][team].

[API reference]: https://docs.rs/embedded-hal-bus

<!--
## Minimum Supported Rust Version (MSRV)


This crate is guaranteed to compile on stable Rust 1.54 and up. It *might*
compile with older versions but that may change in any new patch release.
-->

See [here](../docs/msrv.md) for details on how the MSRV may be upgraded.


## License

Expand Down