Skip to content

Commit ec12446

Browse files
GSMLG-BOTGSMLG-BOT
committed
ci: add GitHub Actions workflows for CI and releases
- Add CI workflow with automated testing on all pushes - Test matrix with Elixir 1.18 and OTP 27/28 - Include code formatting, credo, dialyzer, and coverage reporting - Add release workflow for manual Hex.pm publishing - Automatic version update and GitHub release creation
1 parent 6912931 commit ec12446

File tree

2 files changed

+222
-0
lines changed

2 files changed

+222
-0
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ "*" ]
6+
7+
env:
8+
MIX_ENV: test
9+
10+
jobs:
11+
test:
12+
name: Test on Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }}
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
matrix:
17+
elixir: ['1.18']
18+
otp: ['27', '28']
19+
20+
steps:
21+
- name: Checkout code
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Erlang/OTP
25+
uses: erlef/setup-beam@v1
26+
with:
27+
otp-version: ${{ matrix.otp }}
28+
elixir-version: ${{ matrix.elixir }}
29+
30+
- name: Cache dependencies
31+
uses: actions/cache@v3
32+
with:
33+
path: |
34+
deps
35+
_build
36+
key: ${{ runner.os }}-mix-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
37+
restore-keys: |
38+
${{ runner.os }}-mix-${{ matrix.otp }}-${{ matrix.elixir }}-
39+
40+
- name: Install dependencies
41+
run: mix deps.get --only $MIX_ENV
42+
43+
- name: Compile dependencies
44+
run: mix deps.compile
45+
46+
- name: Compile project
47+
run: mix compile --warnings-as-errors
48+
49+
- name: Check formatting
50+
run: mix format --check-formatted
51+
52+
- name: Run credo
53+
run: mix credo --strict
54+
55+
- name: Run tests
56+
run: mix test --cover
57+
58+
- name: Upload coverage reports to Codecov
59+
uses: codecov/codecov-action@v3
60+
with:
61+
file: _build/test/cover/excoveralls.json
62+
flags: unittests
63+
name: codecov-umbrella
64+
fail_ci_if_error: true
65+
66+
dialyzer:
67+
name: Dialyzer
68+
runs-on: ubuntu-latest
69+
70+
steps:
71+
- name: Checkout code
72+
uses: actions/checkout@v4
73+
74+
- name: Setup Erlang/OTP
75+
uses: erlef/setup-beam@v1
76+
with:
77+
otp-version: '27'
78+
elixir-version: '1.18'
79+
80+
- name: Cache dependencies
81+
uses: actions/cache@v3
82+
with:
83+
path: |
84+
deps
85+
_build
86+
key: ${{ runner.os }}-mix-dialyzer-${{ hashFiles('**/mix.lock') }}
87+
restore-keys: |
88+
${{ runner.os }}-mix-dialyzer-
89+
90+
- name: Install dependencies
91+
run: mix deps.get --only $MIX_ENV
92+
93+
- name: Compile dependencies
94+
run: mix deps.compile
95+
96+
- name: Compile project
97+
run: mix compile
98+
99+
- name: Run dialyzer
100+
run: mix dialyzer --format github

‎.github/workflows/release.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
name: Release
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
version:
7+
description: 'Release version (e.g., 1.0.0)'
8+
required: true
9+
type: string
10+
11+
env:
12+
MIX_ENV: prod
13+
14+
jobs:
15+
test:
16+
name: Test before release
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
23+
- name: Setup Erlang/OTP
24+
uses: erlef/setup-beam@v1
25+
with:
26+
otp-version: '27'
27+
elixir-version: '1.18'
28+
29+
- name: Cache dependencies
30+
uses: actions/cache@v3
31+
with:
32+
path: |
33+
deps
34+
_build
35+
key: ${{ runner.os }}-mix-release-${{ hashFiles('**/mix.lock') }}
36+
37+
- name: Install dependencies
38+
run: mix deps.get --only $MIX_ENV
39+
40+
- name: Compile dependencies
41+
run: mix deps.compile
42+
43+
- name: Compile project
44+
run: mix compile
45+
46+
- name: Run tests
47+
run: mix test
48+
49+
release:
50+
name: Release to Hex.pm
51+
runs-on: ubuntu-latest
52+
needs: test
53+
54+
steps:
55+
- name: Checkout code
56+
uses: actions/checkout@v4
57+
58+
- name: Setup Erlang/OTP
59+
uses: erlef/setup-beam@v1
60+
with:
61+
otp-version: '27'
62+
elixir-version: '1.18'
63+
64+
- name: Cache dependencies
65+
uses: actions/cache@v3
66+
with:
67+
path: |
68+
deps
69+
_build
70+
key: ${{ runner.os }}-mix-release-${{ hashFiles('**/mix.lock') }}
71+
72+
- name: Install dependencies
73+
run: mix deps.get --only $MIX_ENV
74+
75+
- name: Compile dependencies
76+
run: mix deps.compile
77+
78+
- name: Compile project
79+
run: mix compile
80+
81+
- name: Update version in mix.exs
82+
run: |
83+
sed -i "s/version: \".*\"/version: \"${{ github.event.inputs.version }}\"/" mix.exs
84+
git diff mix.exs
85+
86+
- name: Generate documentation
87+
run: mix docs
88+
89+
- name: Publish to Hex.pm
90+
env:
91+
HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
92+
run: mix hex.publish --yes
93+
94+
- name: Create GitHub Release
95+
uses: actions/create-release@v1
96+
env:
97+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
98+
with:
99+
tag_name: v${{ github.event.inputs.version }}
100+
release_name: Release v${{ github.event.inputs.version }}
101+
body: |
102+
## Changes in v${{ github.event.inputs.version }}
103+
104+
This release was created automatically from the release workflow.
105+
106+
### Installation
107+
108+
Add `concord` to your dependencies in `mix.exs`:
109+
110+
```elixir
111+
def deps do
112+
[
113+
{:concord, "~> ${{ github.event.inputs.version }}"}
114+
]
115+
end
116+
```
117+
118+
### Documentation
119+
120+
Documentation is available at: https://hexdocs.pm/concord/${{ github.event.inputs.version }}
121+
draft: false
122+
prerelease: false

0 commit comments

Comments
 (0)