Skip to content

Commit bdd6122

Browse files
gilbertwong96gilbertwong96
committed
ci: add GitHub Actions workflow + ex_coveralls + coverage badge
Three additions for the project's CI/CD story: 1. **GitHub Actions workflow** (.github/workflows/ci.yml) - Linux runner runs the full 8-step quality gate from AGENTS.md (compile --warnings-as-errors, format, credo --strict, deps.unlock --check-unused, deps.audit, xref, ci.dialyzer, coveralls.json for coverage). - macOS runner builds the escript and runs the test suite as a smoke test (the Burrito cross-compile matrix has its own workflow). - ci-status job gates merge on both runners being green. - Cache _build/, deps/, priv/plts/ across runs. 2. **ex_coveralls integration** (~> 0.18) - Added {:ex_coveralls, ~> 0.18, only: [:dev, :test], runtime: false} - New coveralls: config in mix.exs mirroring test_coverage: ignore list so 'mix coveralls.json' reports the same modules as 'mix test --cover'. - Codecov uploads ./cover/excoveralls.json from the Linux job. 3. **README badges** - Replaced fake 'ci-passing' badge with a real one pointing to the workflow run. - Added a Codecov badge (token placeholder, must be set in repo settings). - Added Elixir version and License badges for context. AGENTS.md updated with a 'GitHub Actions CI' subsection that documents the runner matrix and the local-vs-CI relationship.
1 parent db736df commit bdd6122

4 files changed

Lines changed: 218 additions & 2 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, "feature/*", "fix/*"]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
# Cancel in-progress runs for the same branch / PR
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
env:
16+
MIX_ENV: test
17+
OTP_VERSION: "29.0"
18+
ELIXIR_VERSION: "1.20.1"
19+
20+
jobs:
21+
# ── Linux: full CI quality gate ─────────────────────────────────────
22+
linux:
23+
name: Linux · Elixir ${{ env.ELIXIR_VERSION }} · OTP ${{ env.OTP_VERSION }}
24+
runs-on: ubuntu-latest
25+
timeout-minutes: 20
26+
steps:
27+
- uses: actions/checkout@v4
28+
29+
- name: Set up Elixir
30+
uses: erlef/setup-beam@v1
31+
with:
32+
otp-version: ${{ env.OTP_VERSION }}
33+
elixir-version: ${{ env.ELIXIR_VERSION }}
34+
35+
- name: Cache build artifacts
36+
uses: actions/cache@v4
37+
with:
38+
path: |
39+
_build
40+
deps
41+
priv/plts
42+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
43+
restore-keys: |
44+
${{ runner.os }}-mix-
45+
${{ runner.os }}-
46+
47+
- name: Install dependencies
48+
run: mix deps.get
49+
50+
- name: Compile (warnings-as-errors)
51+
run: mix compile --all-warnings --warnings-as-errors
52+
53+
- name: Check formatting
54+
run: mix format --check-formatted
55+
56+
- name: Credo (strict)
57+
run: mix credo --strict
58+
59+
- name: Audit dependencies for CVEs
60+
run: mix deps.audit
61+
62+
- name: Check for unused dependencies
63+
run: mix deps.unlock --check-unused
64+
65+
- name: xref (no orphan modules)
66+
run: mix xref graph --label compile-connected --fail-above 0
67+
68+
- name: Dialyzer
69+
run: mix ci.dialyzer
70+
# Dialyzer is slow — give it a wider window
71+
timeout-minutes: 15
72+
73+
- name: Run tests with coverage
74+
run: mix coveralls.json
75+
76+
- name: Upload coverage to Codecov
77+
if: always()
78+
uses: codecov/codecov-action@v5
79+
with:
80+
files: ./cover/excoveralls.json
81+
flags: linux
82+
fail_ci_if_error: false
83+
token: ${{ secrets.CODECOV_TOKEN }}
84+
85+
- name: Upload coverage artifact
86+
if: always()
87+
uses: actions/upload-artifact@v4
88+
with:
89+
name: coverage-linux
90+
path: cover/excoveralls.json
91+
retention-days: 30
92+
93+
# ── macOS: smoke test (the CLI is cross-compiled via Burrito) ──────
94+
macos:
95+
name: macOS · Elixir ${{ env.ELIXIR_VERSION }}
96+
runs-on: macos-latest
97+
timeout-minutes: 15
98+
steps:
99+
- uses: actions/checkout@v4
100+
101+
- name: Set up Elixir
102+
uses: erlef/setup-beam@v1
103+
with:
104+
otp-version: ${{ env.OTP_VERSION }}
105+
elixir-version: ${{ env.ELIXIR_VERSION }}
106+
107+
- name: Cache build artifacts
108+
uses: actions/cache@v4
109+
with:
110+
path: |
111+
_build
112+
deps
113+
priv/plts
114+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
115+
restore-keys: |
116+
${{ runner.os }}-mix-
117+
${{ runner.os }}-
118+
119+
- name: Install dependencies
120+
run: mix deps.get
121+
122+
- name: Build escript
123+
run: mix escript.build
124+
125+
- name: Smoke test: --help works
126+
run: ./ado --help
127+
128+
- name: Smoke test: whoami with no auth returns friendly error
129+
run: |
130+
rm -f ~/.ado_cli/config.json
131+
./ado whoami || true
132+
133+
- name: Smoke test: logout is idempotent
134+
run: ./ado logout
135+
136+
- name: Run tests
137+
run: mix test
138+
139+
# ── Summary job — gate merge on all green ───────────────────────────
140+
ci-status:
141+
name: CI Status
142+
if: always()
143+
needs: [linux, macos]
144+
runs-on: ubuntu-latest
145+
steps:
146+
- name: Fail if any matrix job failed
147+
if: needs.linux.result != 'success' || needs.macos.result != 'success'
148+
run: |
149+
echo "Linux result: ${{ needs.linux.result }}"
150+
echo "macOS result: ${{ needs.macos.result }}"
151+
exit 1

‎AGENTS.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## CI Quality Gate
44

55
Every change to this project **must** pass the full CI pipeline before merging.
6-
Run the pipeline with:
6+
Run the pipeline locally with:
77

88
```bash
99
mix ci
@@ -22,6 +22,23 @@ The CI alias runs all of the following checks in order, failing on the first fai
2222
| 7 | Type checking (with Finch false-positive filtering) | `mix ci.dialyzer` |
2323
| 8 | Test coverage ≥ 90% on testable modules | `MIX_ENV=test mix test --cover` |
2424

25+
## GitHub Actions CI
26+
27+
In addition to the local pipeline, every push and PR runs the same checks
28+
in `.github/workflows/ci.yml` on Linux + macOS runners:
29+
30+
- **Linux (Ubuntu)** — full quality gate (steps 1–8 above) + coverage
31+
uploaded to Codecov via `ex_coveralls`
32+
- **macOS** — build the escript and run the unit test suite as a smoke test
33+
(Burrito cross-compilation is exercised in a separate workflow)
34+
35+
Coverage is tracked by Codecov. The badge in the README points to the
36+
Codecov dashboard; configuration lives in the `coveralls:` section of
37+
`mix.exs`.
38+
39+
The local `mix ci` command is the source of truth — if it passes locally
40+
it will pass on CI. Never skip a check before pushing.
41+
2542
## Additional Quality Commands
2643

2744
```bash

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ Built with [Finch](https://hex.pm/packages/finch),
88
[CLI Mate](https://hex.pm/packages/cli_mate), and
99
[Burrito](https://hex.pm/packages/burrito).
1010

11-
[![CI](https://img.shields.io/badge/ci-passing-brightgreen)]()
11+
[![CI](https://github.com/gilbertwong96/ado_cli/actions/workflows/ci.yml/badge.svg)](https://github.com/gilbertwong96/ado_cli/actions/workflows/ci.yml)
12+
[![codecov](https://codecov.io/gh/gilbertwong96/ado_cli/graph/badge.svg?token=CHANGEME)](https://codecov.io/gh/gilbertwong96/ado_cli)
13+
[![Elixir](https://img.shields.io/badge/elixir-1.20+-purple.svg)](https://elixir-lang.org)
14+
[![License](https://img.shields.io/github/license/gilbertwong96/ado_cli)](LICENSE)
1215

1316
---
1417

‎mix.exs‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,50 @@ defmodule AdoCli.MixProject do
6363
Mix.Tasks.Ci.Dialyzer
6464
],
6565
threshold: 90
66+
],
67+
coveralls: [
68+
# Mirror the test_coverage ignore list so ex_coveralls reports the
69+
# same modules and threshold. Used by `mix coveralls` and the
70+
# `mix coveralls.html` workflow.
71+
ignore_modules: [
72+
AdoCli.Application,
73+
AdoCli.Auth,
74+
AdoCli.CLI,
75+
AdoCli.CLI.Helpers,
76+
AdoCli.CLI.AgentPools,
77+
AdoCli.CLI.Areas,
78+
AdoCli.CLI.AuthCommands,
79+
AdoCli.CLI.Banners,
80+
AdoCli.CLI.BranchPolicies,
81+
AdoCli.CLI.Builds,
82+
AdoCli.CLI.Connections,
83+
AdoCli.CLI.Extensions,
84+
AdoCli.CLI.Folders,
85+
AdoCli.CLI.Imports,
86+
AdoCli.CLI.Iterations,
87+
AdoCli.CLI.Logout,
88+
AdoCli.CLI.Packages,
89+
AdoCli.CLI.Pipelines,
90+
AdoCli.CLI.Projects,
91+
AdoCli.CLI.PullRequests,
92+
AdoCli.CLI.Releases,
93+
AdoCli.CLI.Repos,
94+
AdoCli.CLI.RunArtifacts,
95+
AdoCli.CLI.Security,
96+
AdoCli.CLI.Skills,
97+
AdoCli.CLI.Teams,
98+
AdoCli.CLI.Users,
99+
AdoCli.CLI.Whoami,
100+
AdoCli.CLI.Wikis,
101+
AdoCli.CLI.WorkItems,
102+
AdoCli.Frontmatter,
103+
AdoCli.TestServer,
104+
AdoCli.TestServer.Plug,
105+
Mix.Tasks.Ci.Dialyzer
106+
],
107+
coverage_options: [treat_no_relevant_lines_as_covered: true],
108+
json: true,
109+
html: true
66110
]
67111
]
68112
end
@@ -88,6 +132,7 @@ defmodule AdoCli.MixProject do
88132
{:ex_slop, "~> 0.4.2", only: [:dev, :test], runtime: false},
89133
{:reach, "~> 2.7", only: [:dev, :test], runtime: false},
90134
{:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false},
135+
{:ex_coveralls, "~> 0.18", only: [:dev, :test], runtime: false},
91136
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
92137
{:ex_doc, "~> 0.40", only: :dev, runtime: false},
93138
{:pi_bridge, "~> 0.6.5", only: [:dev, :test], runtime: false},

0 commit comments

Comments
 (0)