1 name: Continuous Integration Checks
3 on: [push, pull_request]
10 platform: [ ubuntu-latest, windows-latest, macos-latest ]
11 toolchain: [ stable, beta ]
14 platform: ubuntu-latest
16 # 1.48.0 is the MSRV for all crates except lightning-transaction-sync and Win/Mac
18 platform: ubuntu-latest
19 # Windows requires 1.49.0 because that's the MSRV for supported Tokio
21 platform: windows-latest
22 # MacOS-latest requires 1.54.0 because that's what's required for linking to work properly
24 platform: macos-latest
25 runs-on: ${{ matrix.platform }}
27 - name: Checkout source code
28 uses: actions/checkout@v3
29 - name: Install Rust ${{ matrix.toolchain }} toolchain
30 uses: actions-rs/toolchain@v1
32 toolchain: ${{ matrix.toolchain }}
35 - name: Install no-std-check dependencies for ARM Embedded
36 if: "matrix.platform == 'ubuntu-latest'"
38 rustup target add thumbv7m-none-eabi
39 sudo apt-get -y install gcc-arm-none-eabi
40 - name: shellcheck the CI script
41 if: "matrix.platform == 'ubuntu-latest'"
43 sudo apt-get -y install shellcheck
44 shellcheck ci/ci-tests.sh
45 - name: Run CI script with coverage generation
47 shell: bash # Default on Winblows is powershell
48 run: LDK_COVERAGE_BUILD=true ./ci/ci-tests.sh
50 if: "!matrix.coverage"
51 shell: bash # Default on Winblows is powershell
53 - name: Install deps for kcov
57 sudo apt-get -y install binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev
61 wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz
63 cd kcov-master && mkdir build && cd build
66 make install DESTDIR=../../kcov-build
67 cd ../.. && rm -rf kcov-master master.tar.gz
68 - name: Generate coverage report
71 for file in target/debug/deps/lightning*; do
72 [ -x "${file}" ] || continue;
73 mkdir -p "target/cov/$(basename $file)";
74 ./kcov-build/usr/local/bin/kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file";
76 - name: Upload coverage
78 uses: codecov/codecov-action@v3
80 # Could you use this to fake the coverage report for your PR? Sure.
81 # Will anyone be impressed by your amazing coverage? No
82 # Maybe if codecov wasn't broken we wouldn't need to do this...
83 token: f421b687-4dc2-4387-ac3d-dc3b2528af57
84 fail_ci_if_error: true
87 runs-on: ubuntu-latest
91 - name: Checkout source code
92 uses: actions/checkout@v3
93 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
94 uses: actions-rs/toolchain@v1
96 toolchain: ${{ env.TOOLCHAIN }}
99 - name: Cache routing graph snapshot
101 uses: actions/cache@v3
103 path: lightning/net_graph-2023-01-18.bin
104 key: ldk-net_graph-v0.0.113-2023-01-18.bin
105 - name: Fetch routing graph snapshot
106 if: steps.cache-graph.outputs.cache-hit != 'true'
108 curl --verbose -L -o lightning/net_graph-2023-01-18.bin https://bitcoin.ninja/ldk-net_graph-v0.0.113-2023-01-18.bin
109 echo "Sha sum: $(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')"
110 if [ "$(sha256sum lightning/net_graph-2023-01-18.bin | awk '{ print $1 }')" != "${EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM}" ]; then
115 EXPECTED_ROUTING_GRAPH_SNAPSHOT_SHASUM: da6066f2bddcddbe7d8a6debbd53545697137b310bbb8c4911bc8c81fc5ff48c
116 - name: Fetch rapid graph sync reference input
118 curl --verbose -L -o lightning-rapid-gossip-sync/res/full_graph.lngossip https://bitcoin.ninja/ldk-compressed_graph-285cb27df79-2022-07-21.bin
119 echo "Sha sum: $(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')"
120 if [ "$(sha256sum lightning-rapid-gossip-sync/res/full_graph.lngossip | awk '{ print $1 }')" != "${EXPECTED_RAPID_GOSSIP_SHASUM}" ]; then
125 EXPECTED_RAPID_GOSSIP_SHASUM: e0f5d11641c11896d7af3a2246d3d6c3f1720b7d2d17aab321ecce82e6b7deb8
126 - name: Test with Network Graph on Rust ${{ matrix.toolchain }}
129 RUSTFLAGS="--cfg=require_route_graph_test" cargo test
130 RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
132 - name: Run benchmarks on Rust ${{ matrix.toolchain }}
134 RUSTC_BOOTSTRAP=1 cargo bench --features _bench_unstable
137 runs-on: ubuntu-latest
141 - name: Checkout source code
142 uses: actions/checkout@v3
145 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
146 uses: actions-rs/toolchain@v1
148 toolchain: ${{ env.TOOLCHAIN }}
151 - name: Fetch full tree and rebase on upstream
153 git remote add upstream https://github.com/lightningdevkit/rust-lightning
155 export GIT_COMMITTER_EMAIL="rl-ci@example.com"
156 export GIT_COMMITTER_NAME="RL CI"
157 git rebase upstream/main
158 - name: For each commit, run cargo check (including in fuzz)
159 run: ci/check-each-commit.sh upstream/main
162 runs-on: ubuntu-latest
166 - name: Checkout source code
167 uses: actions/checkout@v3
170 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
171 uses: actions-rs/toolchain@v1
173 toolchain: ${{ env.TOOLCHAIN }}
176 - name: Run cargo check for release build.
178 cargo check --release
179 cargo check --no-default-features --features=no-std --release
180 cargo check --no-default-features --features=futures --release
182 RUSTDOCFLAGS="--cfg=anchors" cargo doc --release
185 runs-on: ubuntu-latest
189 - name: Checkout source code
190 uses: actions/checkout@v3
191 - name: Install Rust 1.58 toolchain
192 uses: actions-rs/toolchain@v1
197 - name: Install dependencies for honggfuzz
200 sudo apt-get -y install build-essential binutils-dev libunwind-dev
201 - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }}
202 run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always
204 run: cd fuzz && ./ci-fuzz.sh && cd ..
205 - name: Run lightning-invoice fuzzers
206 run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh
209 runs-on: ubuntu-latest
213 - name: Checkout source code
214 uses: actions/checkout@v3
215 - name: Install Rust ${{ env.TOOLCHAIN }} toolchain
216 uses: actions-rs/toolchain@v1
218 toolchain: ${{ env.TOOLCHAIN }}
221 - name: Install clippy
223 rustup component add clippy
224 - name: Run default clippy linting
226 cargo clippy -- -Aclippy::erasing_op -Aclippy::never_loop -Aclippy::if_same_then_else -Dclippy::try_err