Update README: add maintained badge, release procedure (#192) #351
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: CI | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- "**" | |
jobs: | |
doc: | |
name: Doc | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: dtolnay/rust-toolchain@stable | |
with: | |
toolchain: stable | |
- run: cargo doc --no-deps | |
lint: | |
name: Rustfmt and clippy | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: dtolnay/rust-toolchain@stable | |
with: | |
toolchain: stable | |
- name: Rustfmt | |
run: cargo fmt --all -- --check | |
- name: Clippy | |
run: cargo clippy --workspace --all-targets --all-features -- -D warnings | |
test: | |
name: Test | |
defaults: | |
run: | |
shell: bash | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: | |
- ubuntu-latest | |
- macos-latest | |
- windows-latest | |
rust: | |
- stable | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: dtolnay/rust-toolchain@stable | |
with: | |
toolchain: ${{ matrix.rust }} | |
- name: Install libusb | |
run: | | |
if [[ ${{ matrix.os }} == "ubuntu-latest" ]]; then | |
sudo apt install pkg-config libusb-1.0-0-dev | |
elif [[ ${{ matrix.os }} == "macos-latest" ]]; then | |
brew install pkg-config libusb | |
elif [[ ${{ matrix.os }} == "windows-latest" ]]; then | |
git clone https://github.com/microsoft/vcpkg.git --depth 1 | |
vcpkg/bootstrap-vcpkg.bat | |
vcpkg/vcpkg integrate install | |
vcpkg/vcpkg install libusb | |
fi | |
- name: Test cameleon | |
run: cargo test --workspace --all-targets --all-features | |
# NOTE: --all-targets option doesn't invoke doctest, see https://github.com/rust-lang/cargo/issues/6669. | |
- name: Doctest cameleon | |
run: cargo test --workspace --all-features --doc |