Skip to content

Commit 836f559

Browse files
tchardingtcharding
committed
CI: Use script from rust-bitcoin-maintainer-tools
We have a CI script in the `rust-bitcoin-maintainer-tools` repository, lets use it.
1 parent 92448e1 commit 836f559

File tree

7 files changed

+232
-151
lines changed

7 files changed

+232
-151
lines changed

‎.github/workflows/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# rust-miniscript workflow notes
2+
3+
We are attempting to run max 20 parallel jobs using GitHub actions (usage limit for free tier).
4+
5+
ref: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration
6+
7+
The minimal/recent lock files are handled by CI (`rust.yml`).
8+
9+
## Jobs
10+
11+
Run from `rust.yml` unless stated otherwise. Total 11 jobs.
12+
13+
1. `Stable - minimal`
14+
2. `Stable - recent`
15+
3. `Nightly - minimal`
16+
4. `Nightly - recent`
17+
5. `MSRV - minimal`
18+
6. `Lint`
19+
7. `Docs`
20+
8. `Docsrs`
21+
9. `Bench`
22+
10. `Format`
23+
10. `Int-tests`
24+
11. `Embedded`

‎.github/workflows/rust.yml

+174-51
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,201 @@
1-
on: [push, pull_request]
1+
--- # rust-miniscript CI: If you edit this file please update README.md
2+
on: # yamllint disable-line rule:truthy
3+
push:
4+
branches:
5+
- master
6+
- 'test-ci/**'
7+
pull_request:
28

39
name: Continuous integration
410

511
jobs:
6-
Nightly:
7-
name: Nightly - Bench + Docs + Fmt
12+
Stable: # 2 jobs, one per lock file.
13+
name: Test - stable toolchain
814
runs-on: ubuntu-latest
15+
strategy:
16+
fail-fast: false
17+
matrix:
18+
dep: [minimal, recent]
919
steps:
10-
- name: Checkout Crate
11-
uses: actions/checkout@v2
12-
- name: Checkout Toolchain
13-
uses: actions-rs/toolchain@v1
20+
- name: "Checkout repo"
21+
uses: actions/checkout@v4
22+
- name: "Checkout maintainer tools"
23+
uses: actions/checkout@v4
1424
with:
15-
profile: minimal
16-
toolchain: nightly
17-
override: true
18-
- name: Install clippy
25+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
26+
path: maintainer-tools
27+
- name: "Select toolchain"
28+
uses: dtolnay/rust-toolchain@stable
29+
- name: "Set dependencies"
30+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
31+
- name: "Run test script"
32+
run: ./maintainer-tools/ci/run_task.sh stable
33+
34+
Nightly: # 2 jobs, one per lock file.
35+
name: Test - nightly toolchain
36+
runs-on: ubuntu-latest
37+
strategy:
38+
fail-fast: false
39+
matrix:
40+
dep: [minimal, recent]
41+
steps:
42+
- name: "Checkout repo"
43+
uses: actions/checkout@v4
44+
- name: "Checkout maintainer tools"
45+
uses: actions/checkout@v4
46+
with:
47+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
48+
path: maintainer-tools
49+
- name: "Select toolchain"
50+
uses: dtolnay/rust-toolchain@nightly
51+
- name: "Set dependencies"
52+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
53+
- name: "Run test script"
54+
run: ./maintainer-tools/ci/run_task.sh nightly
55+
56+
MSRV: # 1 jobs, minimal lock file only.
57+
name: Test - 1.56.1 toolchain
58+
runs-on: ubuntu-latest
59+
strategy:
60+
fail-fast: false
61+
matrix:
62+
dep: [minimal]
63+
steps:
64+
- name: "Checkout repo"
65+
uses: actions/checkout@v4
66+
- name: "Checkout maintainer tools"
67+
uses: actions/checkout@v4
68+
with:
69+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
70+
path: maintainer-tools
71+
- name: "Select toolchain"
72+
uses: dtolnay/rust-toolchain@stable
73+
with:
74+
toolchain: "1.56.1"
75+
- name: "Set dependencies"
76+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
77+
- name: "Run test script"
78+
run: ./maintainer-tools/ci/run_task.sh msrv
79+
80+
Lint:
81+
name: Lint - nightly toolchain
82+
runs-on: ubuntu-latest
83+
strategy:
84+
fail-fast: false
85+
matrix:
86+
dep: [recent]
87+
steps:
88+
- name: "Checkout repo"
89+
uses: actions/checkout@v4
90+
- name: "Checkout maintainer tools"
91+
uses: actions/checkout@v4
92+
with:
93+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
94+
path: maintainer-tools
95+
- name: "Select toolchain"
96+
uses: dtolnay/rust-toolchain@nightly
97+
- name: "Install clippy"
1998
run: rustup component add clippy
20-
- name: Running benchmarks
21-
env:
22-
DO_BENCH: true
23-
run: ./contrib/test.sh
24-
- name: Building docs
25-
env:
26-
DO_DOCS: true
27-
run: ./contrib/test.sh
28-
- name: Running formatter
29-
env:
30-
DO_FMT: true
31-
run: ./contrib/test.sh
32-
- name: Running linter
33-
env:
34-
DO_LINT: true
35-
run: ./contrib/test.sh
99+
- name: "Set dependencies"
100+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
101+
- name: "Run test script"
102+
run: ./maintainer-tools/ci/run_task.sh lint
36103

37-
Int-tests:
38-
name: Integration tests
104+
Docs:
105+
name: Docs - stable toolchain
39106
runs-on: ubuntu-latest
107+
strategy:
108+
fail-fast: false
109+
matrix:
110+
dep: [recent]
40111
steps:
41-
- name: Checkout Crate
42-
uses: actions/checkout@v2
43-
- name: Checkout Toolchain
44-
uses: actions-rs/toolchain@v1
112+
- name: "Checkout repo"
113+
uses: actions/checkout@v4
114+
- name: "Checkout maintainer tools"
115+
uses: actions/checkout@v4
45116
with:
46-
profile: minimal
47-
toolchain: stable
48-
override: true
49-
- name: Running integration tests
50-
run: ./contrib/integration_test.sh
117+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
118+
path: maintainer-tools
119+
- name: "Select toolchain"
120+
uses: dtolnay/rust-toolchain@stable
121+
- name: "Set dependencies"
122+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
123+
- name: "Run test script"
124+
run: ./maintainer-tools/ci/run_task.sh docs
125+
126+
Docsrs:
127+
name: Docs - nightly toolchain
128+
runs-on: ubuntu-latest
129+
strategy:
130+
fail-fast: false
131+
matrix:
132+
dep: [recent]
133+
steps:
134+
- name: "Checkout repo"
135+
uses: actions/checkout@v4
136+
- name: "Checkout maintainer tools"
137+
uses: actions/checkout@v4
138+
with:
139+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
140+
path: maintainer-tools
141+
- name: "Select toolchain"
142+
uses: dtolnay/rust-toolchain@nightly
143+
- name: "Set dependencies"
144+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
145+
- name: "Run test script"
146+
run: ./maintainer-tools/ci/run_task.sh docsrs
51147

52-
Tests:
53-
name: Tests
148+
Bench:
149+
name: Bench - nightly toolchain
54150
runs-on: ubuntu-latest
55151
strategy:
152+
fail-fast: false
56153
matrix:
57-
include:
58-
- rust: stable
59-
- rust: beta
60-
- rust: nightly
61-
- rust: "1.56.1"
154+
dep: [recent]
155+
steps:
156+
- name: "Checkout repo"
157+
uses: actions/checkout@v4
158+
- name: "Checkout maintainer tools"
159+
uses: actions/checkout@v4
160+
with:
161+
repository: rust-bitcoin/rust-bitcoin-maintainer-tools
162+
path: maintainer-tools
163+
- name: "Select toolchain"
164+
uses: dtolnay/rust-toolchain@nightly
165+
- name: "Set dependencies"
166+
run: cp Cargo-${{ matrix.dep }}.lock Cargo.lock
167+
- name: "Run test script"
168+
run: ./maintainer-tools/ci/run_task.sh bench
169+
170+
Format: # 1 jobs, run cargo fmt directly.
171+
name: Format - nightly toolchain
172+
runs-on: ubuntu-latest
173+
strategy:
174+
fail-fast: false
175+
steps:
176+
- name: "Checkout repo"
177+
uses: actions/checkout@v4
178+
- name: "Select toolchain"
179+
uses: dtolnay/rust-toolchain@nightly
180+
- name: "Install rustfmt"
181+
run: rustup component add rustfmt
182+
- name: "Check formatting"
183+
run: cargo +nightly fmt --all -- --check
184+
185+
Int-tests:
186+
name: Integration tests
187+
runs-on: ubuntu-latest
62188
steps:
63189
- name: Checkout Crate
64190
uses: actions/checkout@v2
65191
- name: Checkout Toolchain
66192
uses: actions-rs/toolchain@v1
67193
with:
68194
profile: minimal
69-
toolchain: ${{ matrix.rust }}
195+
toolchain: stable
70196
override: true
71-
- name: Running cargo
72-
env:
73-
DO_FEATURE_MATRIX: true
74-
DO_NO_STD: true
75-
run: ./contrib/test.sh
197+
- name: Running integration tests
198+
run: ./contrib/integration_test.sh
76199

77200
Embedded:
78201
runs-on: ubuntu-latest

‎contrib/crates.sh

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env bash
2+
3+
# Crates in this workspace to test (excl. fuzz an integration-tests).
4+
CRATES=(".") # Non-workspaces don't have crates.

‎contrib/pin.sh

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/usr/bin/env bash
2+
#
3+
# Do pinning as required for current MSRV.
4+
5+
set -euo pipefail
6+
7+
cargo update -p cc --precise 1.0.79

‎contrib/test.sh

-100
This file was deleted.

0 commit comments

Comments
 (0)