-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgithub_workflows.ex
More file actions
261 lines (244 loc) · 5.36 KB
/
Copy pathgithub_workflows.ex
File metadata and controls
261 lines (244 loc) · 5.36 KB
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
defmodule GithubWorkflows do
@moduledoc """
Run `mix github_workflows.generate` after updating this module.
See https://hexdocs.pm/github_workflows_generator.
"""
def get do
%{
"ci.yml" => ci_workflow()
}
end
defp ci_workflow do
[
[
name: "CI",
on: [
pull_request: [],
push: [
branches: ["main"]
]
],
jobs: [
compile: compile_job(),
credo: credo_job(),
deps_audit: deps_audit_job(),
dialyzer: dialyzer_job(),
format: format_job(),
hex_audit: hex_audit_job(),
prettier: prettier_job(),
test: test_job(),
unused_deps: unused_deps_job()
]
]
]
end
defp compile_job do
elixir_job("Install deps and compile",
steps: [
[
name: "Install Elixir dependencies",
env: [MIX_ENV: "test"],
run: "mix deps.get"
],
[
name: "Compile",
env: [MIX_ENV: "test"],
run: "mix compile"
]
]
)
end
defp credo_job do
elixir_job("Credo",
needs: :compile,
steps: [
[
name: "Check code style",
env: [MIX_ENV: "test"],
run: "mix credo --strict"
]
]
)
end
defp deps_audit_job do
elixir_job("Deps audit",
needs: :compile,
steps: [
[
name: "Check for vulnerable Mix dependencies",
env: [MIX_ENV: "test"],
run: "mix deps.audit"
]
]
)
end
defp dialyzer_job do
elixir_job("Dialyzer",
needs: :compile,
steps: [
[
name: "Restore PLT cache",
uses: "actions/cache@v3",
with:
[
path: "priv/plts"
] ++ cache_opts(prefix: "plt-${{ matrix.versions.runner-image }}")
],
[
name: "Create PLTs",
env: [MIX_ENV: "test"],
run: "mix dialyzer --plt"
],
[
name: "Run dialyzer",
env: [MIX_ENV: "test"],
run: "mix dialyzer"
]
]
)
end
defp elixir_job(name, opts) do
needs = Keyword.get(opts, :needs)
steps = Keyword.get(opts, :steps, [])
job = [
name: name,
"runs-on": "${{ matrix.versions.runner-image }}",
strategy: [
"fail-fast": false,
matrix: [
versions: [
[
elixir: "1.13",
otp: "22.3",
"runner-image": "ubuntu-20.04"
],
[
elixir: "1.17",
otp: "27.0",
"runner-image": "ubuntu-latest"
]
]
]
],
steps:
[
checkout_step(),
[
name: "Set up Elixir",
uses: "erlef/setup-beam@v1",
with: [
"elixir-version": "${{ matrix.versions.elixir }}",
"otp-version": "${{ matrix.versions.otp }}"
]
],
[
uses: "actions/cache@v3",
with:
[
path: ~S"""
_build
deps
"""
] ++ cache_opts(prefix: "mix-${{ matrix.versions.runner-image }}")
]
] ++ steps
]
if needs do
Keyword.put(job, :needs, needs)
else
job
end
end
defp format_job do
elixir_job("Format",
needs: :compile,
steps: [
[
name: "Check Elixir formatting",
env: [MIX_ENV: "test"],
run: "mix format --check-formatted"
]
]
)
end
defp hex_audit_job do
elixir_job("Hex audit",
needs: :compile,
steps: [
[
name: "Check for retired Hex packages",
env: [MIX_ENV: "test"],
run: "mix hex.audit"
]
]
)
end
defp prettier_job do
[
name: "Check formatting using Prettier",
"runs-on": "ubuntu-latest",
steps: [
checkout_step(),
[
name: "Restore npm cache",
uses: "actions/cache@v3",
id: "npm-cache",
with: [
path: "node_modules",
key: "${{ runner.os }}-prettier"
]
],
[
name: "Install Prettier",
if: "steps.npm-cache.outputs.cache-hit != 'true'",
run: "npm i -D prettier prettier-plugin-toml"
],
[
name: "Run Prettier",
run: "npx prettier -c ."
]
]
]
end
defp test_job do
elixir_job("Test",
needs: :compile,
steps: [
[
name: "Run tests",
env: [
MIX_ENV: "test"
],
run: "mix test --cover --warnings-as-errors"
]
]
)
end
defp unused_deps_job do
elixir_job("Check unused deps",
needs: :compile,
steps: [
[
name: "Check for unused Mix dependencies",
env: [MIX_ENV: "test"],
run: "mix deps.unlock --check-unused"
]
]
)
end
defp checkout_step do
[
name: "Checkout",
uses: "actions/checkout@v4"
]
end
defp cache_opts(opts) do
prefix = Keyword.get(opts, :prefix)
[
key: "#{prefix}-${{ matrix.versions.otp }}-${{ matrix.versions.elixir }}-${{ github.sha }}",
"restore-keys": ~s"""
#{prefix}-
"""
]
end
end