-
Notifications
You must be signed in to change notification settings - Fork 1
268 lines (223 loc) · 11.2 KB
/
ci.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
# Runs checks, tests, code analysis, auto-formats code, applies recommended
# fixes, and publishes documentation.
name: Continuous integration
on: [ push, pull_request ]
permissions:
contents: write
pages: write
id-token: write
jobs:
cancel-runs:
runs-on: ubuntu-latest
steps:
# If this workflow is already in progress or queued, we cancel it; we are
# about to do the exact same tests and documentation on potentially new
# code, so it is pointless to continue them.
- name: Cancel existing workflow runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}
# Automatically applies suggested fixes from `clippy` and formats with rustfmt.
fix-n-format:
runs-on: ubuntu-latest
continue-on-error: true
outputs:
# The ID of the commit made for the fixes, or, if no fixes were applied,
# the commit that triggered the workflow.
commit-id: ${{ steps.commit-id.outputs.COMMIT_ID }}
steps:
# Check out (a.k.a. clones) the AquariWM repository.
- name: Checkout AquariWM
uses: actions/checkout@v4
# Install `libsystemd-dev`, `libudev-dev`, `libseat-dev`, `libinput-dev`, and
# `libxkbcommon-dev` to satisfy dependencies.
- name: Install system libraries required to build AquariWM
run: |
sudo apt-get update
sudo apt-get install libsystemd-dev libudev-dev libseat-dev libinput-dev libxkbcommon-dev
# Install the latest nightly release of the Rust toolchain.
- name: Install latest nightly
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
components: clippy, rustfmt
- name: Configure git credentials
run: |
git config user.name github-actions
git config user.email [email protected]
# Apply fixes with `clippy`.
- name: Apply recommended fixes
uses: actions-rs/cargo@v1
with:
command: clippy
args: --workspace --fix --color always
- name: Commit clippy fix changes
# Commit changes, or, if that fails, do nothing.
run: |
git pull origin ${{ github.ref }}
git diff --quiet || echo "### Applied recommended clippy fixes." >> $GITHUB_STEP_SUMMARY
git diff --quiet || (git commit -am "[CI${{ github.run_number}}] applied recommended clippy fixes" && echo "$(git log --format='%H' -n 1)" >> $GITHUB_STEP_SUMMARY && echo "$(git log --format='%H' -n 1)" >> .git-blame-ignore-revs)
# Automatically format the code with `rustfmt`.
- name: Format code with `rustfmt`
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all
- name: Commit rustfmt changes
run: |
git pull origin ${{ github.ref }}
git diff --quiet || echo "### Formatted code with rustfmt." >> $GITHUB_STEP_SUMMARY
git diff --quiet || (git commit -am "[CI${{ github.run_number}}] formatted code with rustfmt" && echo "$(git log --format='%H' -n 1)" >> $GITHUB_STEP_SUMMARY && echo "$(git log --format='%H' -n 1)" >> .git-blame-ignore-revs)
# This sets the `commit-id` to the latest commit. If there were changes
# made, that means it will be the commit for those changes, otherwise it
# will be the commit that triggered the workflow.
- name: Set the `commit-id` output
id: commit-id
run: echo "COMMIT_ID=$(git log --format='%H' -n 1)" >> $GITHUB_OUTPUT
- name: Push changes
run: |
git push origin HEAD:${{ github.ref }} || :
# Runs unit tests.
run-tests:
needs: fix-n-format
if: success() || failure()
runs-on: ubuntu-latest
steps:
# Check out (a.k.a. clones) the AquariWM repository.
- name: Checkout AquariWM
uses: actions/checkout@v4
with:
ref: ${{ needs.fix-n-format.outputs.commit-id }}
# Install `libsystemd-dev`, `libudev-dev`, `libseat-dev`, `libinput-dev`, and
# `libxkbcommon-dev` to satisfy dependencies.
- name: Install system libraries required to build AquariWM
run: |
sudo apt-get update
sudo apt-get install libsystemd-dev libudev-dev libseat-dev libinput-dev libxkbcommon-dev
# Install the latest nightly release of the Rust toolchain.
- name: Install latest nightly
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
# Matches test failures so annotations can be added and such.
- name: Add test problem matching
run: echo "::add-matcher::.github/test-problem-matcher.json"
# Run unit tests with `cargo test`.
- name: Run tests
run: cargo test --workspace --color never
- name: Remove test problem matching
if: ${{ success() || failure() }}
run: echo "::remove-matcher owner=rust-tests::"
# Analyses the code with `clippy`.
clippy-analysis:
runs-on: ubuntu-latest
# We run clippy analysis after any fixes that can be applied have been.
needs: fix-n-format
if: success() || failure()
steps:
# Check out (a.k.a. clones) the AquariWM repository with fixes made by `clippy`
# in `clippy-fixes`, if any.
- name: Checkout AquariWM
uses: actions/checkout@v4
with:
ref: ${{ needs.fix-n-format.outputs.commit-id }}
# Install `libsystemd-dev`, `libudev-dev`, `libseat-dev`, `libinput-dev`, and
# `libxkbcommon-dev` to satisfy dependencies.
- name: Install system libraries required to build AquariWM
run: |
sudo apt-get update
sudo apt-get install libsystemd-dev libudev-dev libseat-dev libinput-dev libxkbcommon-dev
# Install the latest nightly release of the Rust toolchain.
- name: Install latest nightly
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
components: clippy
# Matches errors, warnings, etc. so annotations can be added and such.
- name: Add Rust problem matching
run: echo "::add-matcher::.github/rustc-problem-matcher.json"
# Analyse the code with `clippy`.
- name: Clippy analysis
run: cargo clippy --workspace --color never
- name: Remove Rust problem matching
if: ${{ success() || failure() }}
run: echo "::remove-matcher owner=rustc::"
# Generate the docs with rustdoc.
build-docs:
runs-on: ubuntu-latest
# We only build the documentation after the code has been changed so that
# the code sources linked in the documentation are up-to-date.
needs: fix-n-format
if: success() || failure()
steps:
# Check out (a.k.a. clones) the AquariWM repository with fixes made by `clippy` in
# `clippy-fixes`, if any, and formatting made by `rustfmt` in `auto-format`, if any.
- name: Checkout AquariWM
uses: actions/checkout@v4
with:
ref: ${{ needs.fix-n-format.outputs.commit-id }}
path: aquariwm
# Install `libsystemd-dev`, `libudev-dev`, `libseat-dev`, `libinput-dev`, and
# `libxkbcommon-dev` to satisfy dependencies.
- name: Install system libraries required to build AquariWM
run: |
sudo apt-get update
sudo apt-get install libsystemd-dev libudev-dev libseat-dev libinput-dev libxkbcommon-dev
# Check out a template to put the generated docs in.
- name: Checkout AquariWM docs template
uses: actions/checkout@v4
with:
repository: AquariWM/aquariwm-docs-template
path: template
# Install the Rust toolchain so that docs can be generated.
- name: Install latest nightly
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: nightly
override: true
# Matches errors, warnings, etc. so annotations can be added and such.
- name: Add Rust problem matching
run: echo "::add-matcher::aquariwm/.github/rustc-problem-matcher.json"
# Setup GitHub Pages to easily deploy to it.
- name: Setup GitHub Pages
uses: actions/configure-pages@v3
# Build documentation with `rustdoc`.
- name: Build documentation
working-directory: aquariwm
run: cargo doc --no-deps --workspace --color never
- name: Remove Rust problem matching
if: ${{ success() || failure() }}
run: echo "::remove-matcher owner=rustc::"
# Place the built documentation into the template, ready to be deployed.
- name: Move generated docs into docs template
run: mv aquariwm/target/doc template/doc
# Upload the template, now containing the built docs, as an artifact that
# can be accessed by the `deploy-docs` job.
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v2
with:
path: template
# Deploy the documentation with GitHub Pages.
deploy-docs:
if: github.event_name == 'push' && github.ref_type == 'branch' && github.ref_name == 'main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
# Can't deploy the documentation until it exists!
needs: build-docs
steps:
# Deploys the documentation to GitHub Pages using the artifact (stored
# but not committed changes for Actions) saved earlier.
- name: Deploy documentation to GitHub Pages
uses: actions/deploy-pages@v2