Skip to content

Commit 7eeeee2

Browse files
committed
Make YAML style clearer and more consistent
In GitHub Actions workflow files, this separates top-level keys within a job with blank lines, which was sometimes but not usually already done, since this seems to improve readability. Besides that, this also applies the prevailing style more consistently. This style tweak is in preparation for adding explicit `permissions` keys (so that doing so won't decrease readability).
1 parent ccd6525 commit 7eeeee2

File tree

5 files changed

+65
-33
lines changed

5 files changed

+65
-33
lines changed

.github/workflows/ci.yml

+26-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
name: ci
22

3-
env:
4-
CARGO_TERM_COLOR: always
5-
CLICOLOR: 1
6-
73
on:
84
push:
95
branches:
@@ -17,10 +13,16 @@ on:
1713
- main
1814
workflow_dispatch:
1915

16+
env:
17+
CARGO_TERM_COLOR: always
18+
CLICOLOR: 1
19+
2020
jobs:
2121
pure-rust-build:
2222
runs-on: ubuntu-latest
23+
2324
container: debian:stable-slim
25+
2426
steps:
2527
- uses: actions/checkout@v4
2628
- name: Prerequisites
@@ -47,13 +49,13 @@ jobs:
4749

4850
test:
4951
runs-on: ubuntu-latest
52+
5053
steps:
5154
- uses: actions/checkout@v4
5255
- uses: dtolnay/rust-toolchain@stable
5356
- uses: Swatinem/rust-cache@v2
5457
- name: Setup dependencies
55-
run:
56-
sudo apt-get install -y --no-install-recommends liblzma-dev tree
58+
run: sudo apt-get install -y --no-install-recommends liblzma-dev tree
5759
- uses: extractions/setup-just@v2
5860
- uses: taiki-e/install-action@v2
5961
with:
@@ -71,7 +73,9 @@ jobs:
7173
- windows-latest
7274
- macos-latest
7375
- ubuntu-latest
76+
7477
runs-on: ${{ matrix.os }}
78+
7579
steps:
7680
- uses: actions/checkout@v4
7781
- uses: dtolnay/rust-toolchain@stable
@@ -97,6 +101,7 @@ jobs:
97101

98102
test-fixtures-windows:
99103
runs-on: windows-latest
104+
100105
steps:
101106
- uses: actions/checkout@v4
102107
- uses: dtolnay/rust-toolchain@stable
@@ -133,9 +138,11 @@ jobs:
133138
134139
test-32bit:
135140
runs-on: ubuntu-latest
141+
136142
strategy:
137143
matrix:
138144
target: [ armv7-linux-androideabi ]
145+
139146
steps:
140147
- uses: actions/checkout@v4
141148
- uses: dtolnay/rust-toolchain@stable
@@ -157,6 +164,7 @@ jobs:
157164

158165
lint:
159166
runs-on: ubuntu-latest
167+
160168
steps:
161169
- uses: actions/checkout@v4
162170
- uses: dtolnay/rust-toolchain@master
@@ -181,6 +189,7 @@ jobs:
181189
182190
cargo-deny:
183191
runs-on: ubuntu-latest
192+
184193
strategy:
185194
matrix:
186195
checks:
@@ -198,11 +207,15 @@ jobs:
198207

199208
wasm:
200209
name: WebAssembly
210+
201211
runs-on: ubuntu-latest
212+
202213
continue-on-error: true
214+
203215
strategy:
204216
matrix:
205217
target: [ wasm32-unknown-unknown, wasm32-wasi ]
218+
206219
steps:
207220
- uses: actions/checkout@master
208221
- name: Install Rust
@@ -230,10 +243,13 @@ jobs:
230243
# However, when changes are made to `etc/copy-packetline.sh`, re-enable the other platforms for testing.
231244
# - macos-latest
232245
# - windows-latest
246+
233247
runs-on: ${{ matrix.os }}
248+
234249
defaults:
235250
run:
236251
shell: bash
252+
237253
steps:
238254
- uses: actions/checkout@v4
239255
- name: Check that working tree is initially clean
@@ -252,6 +268,7 @@ jobs:
252268
# Dummy job to have a stable name for the "all tests pass" requirement
253269
tests-pass:
254270
name: Tests pass
271+
255272
needs:
256273
- pure-rust-build
257274
- test
@@ -261,8 +278,11 @@ jobs:
261278
- cargo-deny
262279
- wasm
263280
- check-packetline
281+
264282
if: always() # always run even if dependencies fail
283+
265284
runs-on: ubuntu-latest
285+
266286
steps:
267287
# fail if ANY dependency has failed or cancelled
268288
- if: "contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')"

.github/workflows/cifuzz.yml

+26-21
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: CIFuzz
2+
23
on:
34
pull_request:
45
branches:
@@ -14,25 +15,29 @@ on:
1415
- '*.toml'
1516
- Makefile
1617
workflow_dispatch:
18+
1719
jobs:
18-
Fuzzing:
19-
runs-on: ubuntu-latest
20-
steps:
21-
- name: Build Fuzzers
22-
id: build
23-
uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
24-
with:
25-
oss-fuzz-project-name: 'gitoxide'
26-
language: rust
27-
- name: Run Fuzzers
28-
uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
29-
with:
30-
oss-fuzz-project-name: 'gitoxide'
31-
language: rust
32-
fuzz-seconds: 600
33-
- name: Upload Crash
34-
uses: actions/upload-artifact@v4
35-
if: failure() && steps.build.outcome == 'success'
36-
with:
37-
name: artifacts
38-
path: ./out/artifacts
20+
Fuzzing:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- name: Build Fuzzers
25+
id: build
26+
uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master
27+
with:
28+
oss-fuzz-project-name: gitoxide
29+
language: rust
30+
31+
- name: Run Fuzzers
32+
uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master
33+
with:
34+
oss-fuzz-project-name: gitoxide
35+
language: rust
36+
fuzz-seconds: 600
37+
38+
- name: Upload Crash
39+
uses: actions/upload-artifact@v4
40+
if: failure() && steps.build.outcome == 'success'
41+
with:
42+
name: artifacts
43+
path: ./out/artifacts

.github/workflows/cron.yml

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
name: cron
22

33
on:
4-
schedule:
4+
schedule:
55
- cron: '0 13,1 * * *'
66
workflow_dispatch:
77

88
jobs:
99
stress:
1010
runs-on: ubuntu-latest
11+
1112
steps:
12-
- uses: actions/checkout@v4
13-
- uses: Swatinem/rust-cache@v2
14-
- name: stress
15-
run: make stress
13+
- uses: actions/checkout@v4
14+
- uses: Swatinem/rust-cache@v2
15+
- name: stress
16+
run: make stress

.github/workflows/msrv.yml

+4
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,20 @@ on:
1616
jobs:
1717
check-msrv:
1818
name: cargo check MSRV
19+
1920
strategy:
2021
matrix:
2122
os:
2223
- windows-2022
2324
- ubuntu-latest
25+
2426
runs-on: ${{ matrix.os }}
27+
2528
env:
2629
# dictated by `firefox` to support the `helix` editor, but now probably effectively be controlled by `jiff`, which also aligns with `regex`.
2730
# IMPORTANT: adjust etc/msrv-badge.svg as well
2831
rust_version: 1.74.0
32+
2933
steps:
3034
- uses: actions/checkout@v4
3135
- uses: extractions/setup-just@v2

.github/workflows/release.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,9 @@ jobs:
435435
os: windows-latest
436436
rust: stable
437437
target: i686-pc-windows-gnu
438+
438439
runs-on: ${{ matrix.os }}
440+
439441
steps:
440442
- uses: actions/checkout@v4
441443
- name: Install Rust
@@ -449,7 +451,7 @@ jobs:
449451
pacboy: cc:p
450452
path-type: inherit
451453
- name: "Install prerequisites"
452-
run: vcpkg install zlib:x64-windows-static-md
454+
run: vcpkg install zlib:x64-windows-static-md
453455
- name: "Installation from crates.io: gitoxide"
454456
run: cargo +${{ matrix.rust }} install --target ${{ matrix.target }} --no-default-features --features max-pure --target-dir install-artifacts --debug --force gitoxide
455457
shell: msys2 {0}

0 commit comments

Comments
 (0)