Skip to content

Commit d94378b

Browse files
sgfnsgfn
authored
[All] Setup CI (#26)
1 parent d2ac863 commit d94378b

File tree

18 files changed

+649
-47
lines changed

18 files changed

+649
-47
lines changed

Diff for: ‎.github/workflows/build-check-app.yml

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Build and check app
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
workdir:
7+
required: true
8+
type: string
9+
with-ffmpeg:
10+
default: false
11+
type: boolean
12+
13+
permissions:
14+
contents: read
15+
16+
env:
17+
FFMPEG_URL: https://github.com/BtbN/FFmpeg-Builds/releases/download/autobuild-2024-06-30-12-49/ffmpeg-n7.0.1-11-g40ddddca45-linux64-gpl-shared-7.0.tar.xz
18+
19+
jobs:
20+
build_check_app:
21+
runs-on: ubuntu-latest
22+
name: CI on OTP ${{ matrix.otp }} / Elixir ${{ matrix.elixir }} in directory ${{ inputs.workdir }}
23+
strategy:
24+
matrix:
25+
otp: ['26']
26+
elixir: ['1.16']
27+
defaults:
28+
run:
29+
working-directory: ${{ inputs.workdir }}
30+
steps:
31+
- name: Set up Elixir
32+
uses: erlef/setup-beam@v1
33+
with:
34+
otp-version: ${{ matrix.otp }}
35+
elixir-version: ${{ matrix.elixir }}
36+
37+
- name: Install FFmpeg development libraries
38+
if: ${{ inputs.with-ffmpeg }}
39+
working-directory: .
40+
run: |
41+
sudo apt-get update
42+
sudo apt-get install -y wget tar
43+
wget ${{ env.FFMPEG_URL }} -O - | tar xJ
44+
sudo mv ffmpeg-* /opt/ffmpeg
45+
echo "C_INCLUDE_PATH=/opt/ffmpeg/include" >> $GITHUB_ENV
46+
echo "LIBRARY_PATH=/opt/ffmpeg/lib" >> $GITHUB_ENV
47+
echo "LD_LIBRARY_PATH=/opt/ffmpeg/lib" >> $GITHUB_ENV
48+
49+
- name: Checkout the code
50+
uses: actions/checkout@v4
51+
with:
52+
sparse-checkout: ${{ inputs.workdir }}
53+
54+
- name: Cache dependencies
55+
uses: actions/cache@v4
56+
with:
57+
path: ${{ inputs.workdir }}/deps
58+
key: ${{ inputs.workdir }}-${{ runner.os }}-mix-deps-${{ hashFiles('**/mix.lock') }}
59+
restore-keys: |
60+
${{ inputs.workdir }}-${{ runner.os }}-mix-deps-
61+
62+
- name: Cache compiled build
63+
uses: actions/cache@v4
64+
with:
65+
path: ${{ inputs.workdir }}/_build
66+
key: ${{ inputs.workdir }}-${{ runner.os }}-mix-build-${{ hashFiles('**/mix.lock') }}
67+
restore-keys: |
68+
${{ inputs.workdir }}-${{ runner.os }}-mix-build-
69+
${{ inputs.workdir }}-${{ runner.os }}-mix-
70+
71+
- name: Cache dialyzer artifacts
72+
uses: actions/cache@v4
73+
with:
74+
path: ${{ inputs.workdir }}/_dialyzer
75+
key: ${{ inputs.workdir }}-${{ runner.os }}-dialyzer-${{ hashFiles('**/mix.lock') }}
76+
restore-keys: |
77+
${{ inputs.workdir }}-${{ runner.os }}-dialyzer-
78+
79+
- name: Install and setup dependencies
80+
run: mix setup
81+
82+
- name: Compile without warnings
83+
id: compile
84+
run: mix compile --warnings-as-errors
85+
86+
- name: Check formatting
87+
if: ${{ !cancelled() && steps.compile.outcome == 'success' }}
88+
run: mix format --check-formatted
89+
90+
- name: Check with credo
91+
if: ${{ !cancelled() && steps.compile.outcome == 'success' }}
92+
run: mix credo
93+
94+
- name: Check with dialyzer
95+
if: ${{ !cancelled() && steps.compile.outcome == 'success' }}
96+
run: mix dialyzer

Diff for: ‎.github/workflows/ci.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CI
2+
3+
on: push
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
build_check_recognizer:
10+
name: Recognizer CI
11+
uses: ./.github/workflows/build-check-app.yml
12+
with:
13+
workdir: recognizer
14+
with-ffmpeg: true
15+
16+
build_check_broadcaster:
17+
name: Broadcaster CI
18+
uses: ./.github/workflows/build-check-app.yml
19+
with:
20+
workdir: broadcaster

Diff for: ‎broadcaster/.credo.exs

+217
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
# This file contains the configuration for Credo and you are probably reading
2+
# this after creating it with `mix credo.gen.config`.
3+
#
4+
# If you find anything wrong or unclear in this file, please report an
5+
# issue on GitHub: https://github.com/rrrene/credo/issues
6+
#
7+
%{
8+
#
9+
# You can have as many configs as you like in the `configs:` field.
10+
configs: [
11+
%{
12+
#
13+
# Run any config using `mix credo -C <name>`. If no config name is given
14+
# "default" is used.
15+
#
16+
name: "default",
17+
#
18+
# These are the files included in the analysis:
19+
files: %{
20+
#
21+
# You can give explicit globs or simply directories.
22+
# In the latter case `**/*.{ex,exs}` will be used.
23+
#
24+
included: [
25+
"lib/",
26+
"src/",
27+
"test/",
28+
"web/",
29+
"apps/*/lib/",
30+
"apps/*/src/",
31+
"apps/*/test/",
32+
"apps/*/web/"
33+
],
34+
excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
35+
},
36+
#
37+
# Load and configure plugins here:
38+
#
39+
plugins: [],
40+
#
41+
# If you create your own checks, you must specify the source files for
42+
# them here, so they can be loaded by Credo before running the analysis.
43+
#
44+
requires: [],
45+
#
46+
# If you want to enforce a style guide and need a more traditional linting
47+
# experience, you can change `strict` to `true` below:
48+
#
49+
strict: false,
50+
#
51+
# To modify the timeout for parsing files, change this value:
52+
#
53+
parse_timeout: 5000,
54+
#
55+
# If you want to use uncolored output by default, you can change `color`
56+
# to `false` below:
57+
#
58+
color: true,
59+
#
60+
# You can customize the parameters of any check by adding a second element
61+
# to the tuple.
62+
#
63+
# To disable a check put `false` as second element:
64+
#
65+
# {Credo.Check.Design.DuplicatedCode, false}
66+
#
67+
checks: %{
68+
enabled: [
69+
#
70+
## Consistency Checks
71+
#
72+
{Credo.Check.Consistency.ExceptionNames, []},
73+
{Credo.Check.Consistency.LineEndings, []},
74+
{Credo.Check.Consistency.ParameterPatternMatching, []},
75+
{Credo.Check.Consistency.SpaceAroundOperators, []},
76+
{Credo.Check.Consistency.SpaceInParentheses, []},
77+
{Credo.Check.Consistency.TabsOrSpaces, []},
78+
79+
#
80+
## Design Checks
81+
#
82+
# You can customize the priority of any check
83+
# Priority values are: `low, normal, high, higher`
84+
#
85+
{Credo.Check.Design.AliasUsage,
86+
[priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
87+
{Credo.Check.Design.TagFIXME, []},
88+
# You can also customize the exit_status of each check.
89+
# If you don't want TODO comments to cause `mix credo` to fail, just
90+
# set this value to 0 (zero).
91+
#
92+
{Credo.Check.Design.TagTODO, [exit_status: 0]},
93+
94+
#
95+
## Readability Checks
96+
#
97+
{Credo.Check.Readability.AliasOrder, []},
98+
{Credo.Check.Readability.FunctionNames, []},
99+
{Credo.Check.Readability.LargeNumbers, []},
100+
{Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
101+
{Credo.Check.Readability.ModuleAttributeNames, []},
102+
{Credo.Check.Readability.ModuleDoc, []},
103+
{Credo.Check.Readability.ModuleNames, []},
104+
{Credo.Check.Readability.ParenthesesInCondition, []},
105+
{Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
106+
{Credo.Check.Readability.PipeIntoAnonymousFunctions, []},
107+
{Credo.Check.Readability.PredicateFunctionNames, []},
108+
{Credo.Check.Readability.PreferImplicitTry, []},
109+
{Credo.Check.Readability.RedundantBlankLines, []},
110+
{Credo.Check.Readability.Semicolons, []},
111+
{Credo.Check.Readability.SpaceAfterCommas, []},
112+
{Credo.Check.Readability.StringSigils, []},
113+
{Credo.Check.Readability.TrailingBlankLine, []},
114+
{Credo.Check.Readability.TrailingWhiteSpace, []},
115+
{Credo.Check.Readability.UnnecessaryAliasExpansion, []},
116+
{Credo.Check.Readability.VariableNames, []},
117+
{Credo.Check.Readability.WithSingleClause, []},
118+
119+
#
120+
## Refactoring Opportunities
121+
#
122+
{Credo.Check.Refactor.Apply, []},
123+
{Credo.Check.Refactor.CondStatements, []},
124+
{Credo.Check.Refactor.CyclomaticComplexity, []},
125+
{Credo.Check.Refactor.FilterCount, []},
126+
{Credo.Check.Refactor.FilterFilter, []},
127+
{Credo.Check.Refactor.FunctionArity, []},
128+
{Credo.Check.Refactor.LongQuoteBlocks, []},
129+
{Credo.Check.Refactor.MapJoin, []},
130+
{Credo.Check.Refactor.MatchInCondition, []},
131+
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
132+
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
133+
{Credo.Check.Refactor.Nesting, []},
134+
{Credo.Check.Refactor.RedundantWithClauseResult, []},
135+
{Credo.Check.Refactor.RejectReject, []},
136+
{Credo.Check.Refactor.UnlessWithElse, []},
137+
{Credo.Check.Refactor.WithClauses, []},
138+
139+
#
140+
## Warnings
141+
#
142+
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
143+
{Credo.Check.Warning.BoolOperationOnSameValues, []},
144+
{Credo.Check.Warning.Dbg, []},
145+
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
146+
{Credo.Check.Warning.IExPry, []},
147+
{Credo.Check.Warning.IoInspect, []},
148+
{Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
149+
{Credo.Check.Warning.OperationOnSameValues, []},
150+
{Credo.Check.Warning.OperationWithConstantResult, []},
151+
{Credo.Check.Warning.RaiseInsideRescue, []},
152+
{Credo.Check.Warning.SpecWithStruct, []},
153+
{Credo.Check.Warning.UnsafeExec, []},
154+
{Credo.Check.Warning.UnusedEnumOperation, []},
155+
{Credo.Check.Warning.UnusedFileOperation, []},
156+
{Credo.Check.Warning.UnusedKeywordOperation, []},
157+
{Credo.Check.Warning.UnusedListOperation, []},
158+
{Credo.Check.Warning.UnusedPathOperation, []},
159+
{Credo.Check.Warning.UnusedRegexOperation, []},
160+
{Credo.Check.Warning.UnusedStringOperation, []},
161+
{Credo.Check.Warning.UnusedTupleOperation, []},
162+
{Credo.Check.Warning.WrongTestFileExtension, []}
163+
],
164+
disabled: [
165+
#
166+
# Checks scheduled for next check update (opt-in for now)
167+
{Credo.Check.Refactor.UtcNowTruncate, []},
168+
169+
#
170+
# Controversial and experimental checks (opt-in, just move the check to `:enabled`
171+
# and be sure to use `mix credo --strict` to see low priority checks)
172+
#
173+
{Credo.Check.Consistency.MultiAliasImportRequireUse, []},
174+
{Credo.Check.Consistency.UnusedVariableNames, []},
175+
{Credo.Check.Design.DuplicatedCode, []},
176+
{Credo.Check.Design.SkipTestWithoutComment, []},
177+
{Credo.Check.Readability.AliasAs, []},
178+
{Credo.Check.Readability.BlockPipe, []},
179+
{Credo.Check.Readability.ImplTrue, []},
180+
{Credo.Check.Readability.MultiAlias, []},
181+
{Credo.Check.Readability.NestedFunctionCalls, []},
182+
{Credo.Check.Readability.OneArityFunctionInPipe, []},
183+
{Credo.Check.Readability.OnePipePerLine, []},
184+
{Credo.Check.Readability.SeparateAliasRequire, []},
185+
{Credo.Check.Readability.SingleFunctionToBlockPipe, []},
186+
{Credo.Check.Readability.SinglePipe, []},
187+
{Credo.Check.Readability.Specs, []},
188+
{Credo.Check.Readability.StrictModuleLayout, []},
189+
{Credo.Check.Readability.WithCustomTaggedTuple, []},
190+
{Credo.Check.Refactor.ABCSize, []},
191+
{Credo.Check.Refactor.AppendSingleItem, []},
192+
{Credo.Check.Refactor.DoubleBooleanNegation, []},
193+
{Credo.Check.Refactor.FilterReject, []},
194+
{Credo.Check.Refactor.IoPuts, []},
195+
{Credo.Check.Refactor.MapMap, []},
196+
{Credo.Check.Refactor.ModuleDependencies, []},
197+
{Credo.Check.Refactor.NegatedIsNil, []},
198+
{Credo.Check.Refactor.PassAsyncInTestCases, []},
199+
{Credo.Check.Refactor.PipeChainStart, []},
200+
{Credo.Check.Refactor.RejectFilter, []},
201+
{Credo.Check.Refactor.VariableRebinding, []},
202+
{Credo.Check.Warning.LazyLogging, []},
203+
{Credo.Check.Warning.LeakyEnvironment, []},
204+
{Credo.Check.Warning.MapGetUnsafePass, []},
205+
{Credo.Check.Warning.MixEnv, []},
206+
{Credo.Check.Warning.UnsafeToAtom, []}
207+
208+
# {Credo.Check.Refactor.MapInto, []},
209+
210+
#
211+
# Custom checks can be created using `mix credo.gen.check`.
212+
#
213+
]
214+
}
215+
}
216+
]
217+
}

Diff for: ‎broadcaster/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Clone this repo and change the working directory to `apps/broadcaster`.
99
Fetch dependencies and run the app:
1010

1111
```shell
12-
mix deps.get
12+
mix setup
1313
mix phx.server
1414
```
1515

Diff for: ‎broadcaster/lib/broadcaster/forwarder.ex

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
defmodule Broadcaster.Forwarder do
2+
@moduledoc false
3+
24
use GenServer
35

46
require Logger
@@ -239,7 +241,7 @@ defmodule Broadcaster.Forwarder do
239241
{:noreply, %{state | pending_outputs: pending_outputs}}
240242

241243
true ->
242-
dbg({pid, reason})
244+
Logger.warning("Unknown process #{inspect(pid)} died with reason #{inspect(reason)}")
243245
end
244246
end
245247

Diff for: ‎broadcaster/lib/broadcaster/peer_supervisor.ex

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
defmodule Broadcaster.PeerSupervisor do
2+
@moduledoc false
3+
24
use DynamicSupervisor
35

46
require Logger
@@ -33,10 +35,10 @@ defmodule Broadcaster.PeerSupervisor do
3335
DynamicSupervisor.start_link(__MODULE__, arg, name: __MODULE__)
3436
end
3537

36-
@spec start_whip(String.t()) :: {:ok, pid(), String.t()} | {:error, term()}
38+
@spec start_whip(String.t()) :: {:ok, pid(), String.t(), String.t()} | {:error, term()}
3739
def start_whip(offer_sdp), do: start_pc(offer_sdp, :recvonly)
3840

39-
@spec start_whep(String.t()) :: {:ok, pid(), String.t()} | {:error, term()}
41+
@spec start_whep(String.t()) :: {:ok, pid(), String.t(), String.t()} | {:error, term()}
4042
def start_whep(offer_sdp), do: start_pc(offer_sdp, :sendonly)
4143

4244
@spec fetch_pid(String.t()) :: {:ok, pid()} | :error

Diff for: ‎broadcaster/lib/broadcaster_web/channels/stream_channel.ex

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
defmodule BroadcasterWeb.StreamChannel do
2+
@moduledoc false
3+
24
use BroadcasterWeb, :channel
35

46
alias BroadcasterWeb.Presence

0 commit comments

Comments
 (0)