Our features are a bit convoluted, most annoyingly we cannot build with `--all-features`. However we can make life for users a little easier. Explicitly we want users to be able to: - Use async-interface/WASM without using esplora (to implement their own blockchain) - Use esplora in an ergonomic manner Currently using esplora requires either reqwest or ureq. Instead of making the user add all the features manually we can add features that add the required feature sets, this makes it easier for users to understand what is required and also makes usage easier. With this patch applied we can do - `cargo check --no-default-features --features=use-esplora-reqwest` - `cargo check --no-default-features --features=use-esplora-ureq` - `cargo check --features=use-esplora-ureq` - `cargo check --no-default-features --features=async-trait`
161 lines
4.9 KiB
YAML
161 lines
4.9 KiB
YAML
on: [push, pull_request]
|
|
|
|
name: CI
|
|
|
|
jobs:
|
|
|
|
build-test:
|
|
name: Build and test
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
matrix:
|
|
rust:
|
|
- 1.53.0 # STABLE
|
|
- 1.46.0 # MSRV
|
|
features:
|
|
- default
|
|
- minimal
|
|
- all-keys
|
|
- minimal,use-esplora-ureq
|
|
- key-value-db
|
|
- electrum
|
|
- compact_filters
|
|
- esplora,ureq,key-value-db,electrum
|
|
- compiler
|
|
- rpc
|
|
- verify
|
|
- async-interface
|
|
- use-esplora-reqwest
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v2
|
|
- name: Generate cache key
|
|
run: echo "${{ matrix.rust }} ${{ matrix.features }}" | tee .cache_key
|
|
- name: cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: |
|
|
~/.cargo/registry
|
|
~/.cargo/git
|
|
target
|
|
key: ${{ runner.os }}-cargo-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
|
|
- name: Set default toolchain
|
|
run: rustup default ${{ matrix.rust }}
|
|
- name: Set profile
|
|
run: rustup set profile minimal
|
|
- name: Add clippy
|
|
run: rustup component add clippy
|
|
- name: Update toolchain
|
|
run: rustup update
|
|
- name: Build
|
|
run: cargo build --features ${{ matrix.features }} --no-default-features
|
|
- name: Clippy
|
|
run: cargo clippy --all-targets --features ${{ matrix.features }} --no-default-features -- -D warnings
|
|
- name: Test
|
|
run: cargo test --features ${{ matrix.features }} --no-default-features
|
|
|
|
test-readme-examples:
|
|
name: Test README.md examples
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v2
|
|
- name: cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: |
|
|
~/.cargo/registry
|
|
~/.cargo/git
|
|
target
|
|
key: ${{ runner.os }}-cargo-test-md-docs-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
|
|
- name: Set default toolchain
|
|
run: rustup default nightly
|
|
- name: Set profile
|
|
run: rustup set profile minimal
|
|
- name: Update toolchain
|
|
run: rustup update
|
|
- name: Test
|
|
run: cargo test --features test-md-docs --no-default-features -- doctest::ReadmeDoctests
|
|
|
|
test-blockchains:
|
|
name: Test ${{ matrix.blockchain.name }}
|
|
runs-on: ubuntu-20.04
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
blockchain:
|
|
- name: electrum
|
|
- name: rpc
|
|
- name: esplora
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
- name: Cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: |
|
|
~/.cargo/registry
|
|
~/.cargo/bitcoin
|
|
~/.cargo/electrs
|
|
~/.cargo/git
|
|
target
|
|
key: ${{ runner.os }}-cargo-${{ github.job }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
|
|
- name: Setup rust toolchain
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: stable
|
|
override: true
|
|
- name: Test
|
|
run: cargo test --features test-${{ matrix.blockchain.name }} ${{ matrix.blockchain.name }}::bdk_blockchain_tests
|
|
|
|
check-wasm:
|
|
name: Check WASM
|
|
runs-on: ubuntu-16.04
|
|
env:
|
|
CC: clang-10
|
|
CFLAGS: -I/usr/include
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
- name: Cache
|
|
uses: actions/cache@v2
|
|
with:
|
|
path: |
|
|
~/.cargo/registry
|
|
~/.cargo/git
|
|
target
|
|
key: ${{ runner.os }}-cargo-${{ github.job }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
|
|
# Install a recent version of clang that supports wasm32
|
|
- run: wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add - || exit 1
|
|
- run: sudo apt-add-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-10 main" || exit 1
|
|
- run: sudo apt-get update || exit 1
|
|
- run: sudo apt-get install -y libclang-common-10-dev clang-10 libc6-dev-i386 || exit 1
|
|
- name: Set default toolchain
|
|
run: rustup default 1.53.0 # STABLE
|
|
- name: Set profile
|
|
run: rustup set profile minimal
|
|
- name: Add target wasm32
|
|
run: rustup target add wasm32-unknown-unknown
|
|
- name: Update toolchain
|
|
run: rustup update
|
|
- name: Check
|
|
run: cargo check --target wasm32-unknown-unknown --features use-esplora-reqwest --no-default-features
|
|
|
|
|
|
fmt:
|
|
name: Rust fmt
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
- name: Set default toolchain
|
|
run: rustup default nightly
|
|
- name: Set profile
|
|
run: rustup set profile minimal
|
|
- name: Add rustfmt
|
|
run: rustup component add rustfmt
|
|
- name: Update toolchain
|
|
run: rustup update
|
|
- name: Check fmt
|
|
run: cargo fmt --all -- --config format_code_in_doc_comments=true --check
|