From 6f1bf7dd076fbfd65861e15355db41f84de168a6 Mon Sep 17 00:00:00 2001 From: Lyndon Brown Date: Tue, 15 Dec 2020 05:16:10 +0000 Subject: [PATCH 1/2] ci: add use of github actions now that travis has ditched it's free service. --- .github/workflows/test.yml | 98 ++++++++++++++++++++++++++++++++++++++ COMPILING.md | 2 +- README.md | 1 + 3 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/test.yml diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 00000000..63e0175f --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,98 @@ +# Note, this is used in the badge URL! +name: test + +on: + push: + branches: [master, dev] + pull_request: + branches: [master, dev] + +jobs: + fmt: + name: 'Rust: format check' + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + # Only run the formatting check for stable + include: + - os: ubuntu-latest + toolchain: stable + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Install toolchain + uses: actions-rs/toolchain@v1 + with: + # Use default profile to get rustfmt + profile: default + toolchain: ${{ matrix.toolchain }} + override: true + - run: cargo fmt --verbose --all -- --check + + test: + needs: fmt + runs-on: ${{ matrix.os }} + continue-on-error: ${{ matrix.experimental }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest] + toolchain: + - 1.40.0 # MSRV (Minimum supported rust version) + - stable + - beta + experimental: [false] + # Ignore failures in nightly, not ideal, but necessary + include: + - os: ubuntu-latest + toolchain: nightly + experimental: true + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Install toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: ${{ matrix.toolchain }} + override: true + - name: Install developer package dependencies + run: sudo apt-get install libpulse-dev portaudio19-dev libasound2-dev libsdl2-dev gstreamer1.0-dev libgstreamer-plugins-base1.0-dev + - run: cargo build --locked --no-default-features + - run: cargo build --locked --examples + - run: cargo build --locked --no-default-features --features "with-tremor" + - run: cargo build --locked --no-default-features --features "with-vorbis" + - run: cargo build --locked --no-default-features --features "alsa-backend" + - run: cargo build --locked --no-default-features --features "portaudio-backend" + - run: cargo build --locked --no-default-features --features "pulseaudio-backend" + - run: cargo build --locked --no-default-features --features "jackaudio-backend" + - run: cargo build --locked --no-default-features --features "rodio-backend" + - run: cargo build --locked --no-default-features --features "sdl-backend" + - run: cargo build --locked --no-default-features --features "gstreamer-backend" + + test-cross-arm: + needs: fmt + runs-on: ${{ matrix.os }} + continue-on-error: false + strategy: + fail-fast: false + matrix: + include: + - os: ubuntu-latest + target: armv7-unknown-linux-gnueabihf + toolchain: stable + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Install toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + target: ${{ matrix.target }} + toolchain: ${{ matrix.toolchain }} + override: true + - name: Install cross + run: cargo install cross || true + - name: Build + run: cross build --locked --target ${{ matrix.target }} --no-default-features diff --git a/COMPILING.md b/COMPILING.md index 21985fc6..7b3467ee 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -13,7 +13,7 @@ curl https://sh.rustup.rs -sSf | sh Follow any prompts it gives you to install Rust. Once that’s done, Rust's standard tools should be setup and ready to use. -*Note: The current minimum required Rust version at the time of writing is 1.40.0, you can find the current minimum version specified in the `.travis.yml` file.* +*Note: The current minimum required Rust version at the time of writing is 1.40.0, you can find the current minimum version specified in the `.github/workflow/test.yml` file.* #### Additional Rust tools - `rustfmt` To ensure a consistent codebase, we utilise [`rustfmt`](https://github.com/rust-lang/rustfmt), which is installed by default with `rustup` these days, else it can be installed manually with: diff --git a/README.md b/README.md index a729255d..d49aeda1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Build Status](https://img.shields.io/github/workflow/status/librespot-org/librespot/test/dev)](https://github.com/librespot-org/librespot/actions) [![Build Status](https://travis-ci.org/librespot-org/librespot.svg?branch=dev)](https://travis-ci.org/librespot-org/librespot) [![Gitter chat](https://badges.gitter.im/librespot-org/librespot.png)](https://gitter.im/librespot-org/spotify-connect-resources) [![Crates.io](https://img.shields.io/crates/v/librespot.svg)](https://crates.io/crates/librespot) From 013a2fdcbf6634d39e5222d4b0af1770c3cae11c Mon Sep 17 00:00:00 2001 From: Lyndon Brown Date: Tue, 15 Dec 2020 05:49:27 +0000 Subject: [PATCH 2/2] ci: optimise action triggers it is pointless to run CI jobs for pushes / PRs that only change files that would never cause a failure, such as documentation. this avoids wasting resources for such situations. --- .github/workflows/test.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 63e0175f..2376f8b0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -4,8 +4,10 @@ name: test on: push: branches: [master, dev] + paths: ['**.rs', '**.toml', '**.lock', '**.yml'] pull_request: branches: [master, dev] + paths: ['**.rs', '**.toml', '**.lock', '**.yml'] jobs: fmt: