Add coverage reporting/badges and split CI between Gitea and GitHub
Merge dotnet+jest coverage via reportgenerator, publish a self-hosted coverage badge and build-status badges on the readme. Gitea remains the full pipeline (build/test/docker push/deploy-qa/smoke); GitHub only builds and tests since it has no registry secrets or qa runner.
This commit is contained in:
24
.github/workflows/ci.yml
vendored
24
.github/workflows/ci.yml
vendored
@@ -2,15 +2,25 @@
|
|||||||
# (both look under .github/workflows/). Every non-checkout step just invokes a
|
# (both look under .github/workflows/). Every non-checkout step just invokes a
|
||||||
# bash script under scripts/ci/, so the entire pipeline is reproducible by
|
# bash script under scripts/ci/, so the entire pipeline is reproducible by
|
||||||
# running the same scripts locally - no marketplace build/test/push actions.
|
# running the same scripts locally - no marketplace build/test/push actions.
|
||||||
|
#
|
||||||
|
# Gitea (origin) is the internal/testing remote and runs the full pipeline:
|
||||||
|
# build, test, docker push, deploy-to-qa, smoke test. GitHub is the public
|
||||||
|
# mirror and only needs to prove the code builds and tests pass - it has no
|
||||||
|
# registry secrets and no [self-hosted, qa] runner, so the docker push and
|
||||||
|
# deploy/smoke jobs are skipped there via the `github.server_url` check
|
||||||
|
# below (identical on both engines: https://github.com on GitHub, the Gitea
|
||||||
|
# instance URL on Gitea).
|
||||||
name: CI
|
name: CI
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main, build-runner-fix]
|
paths-ignore: [badges/**]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-and-push:
|
build-and-push:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
env:
|
env:
|
||||||
REGISTRY: ${{ secrets.REGISTRY }}
|
REGISTRY: ${{ secrets.REGISTRY }}
|
||||||
REGISTRY_OWNER: ${{ secrets.REGISTRY_OWNER }}
|
REGISTRY_OWNER: ${{ secrets.REGISTRY_OWNER }}
|
||||||
@@ -25,14 +35,25 @@ jobs:
|
|||||||
- name: Test
|
- name: Test
|
||||||
run: ./scripts/ci/test.sh
|
run: ./scripts/ci/test.sh
|
||||||
|
|
||||||
|
- name: Coverage report
|
||||||
|
run: ./scripts/ci/coverage.sh
|
||||||
|
|
||||||
|
- name: Publish coverage badge
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
|
run: ./scripts/ci/publish-coverage-badge.sh
|
||||||
|
|
||||||
- name: Build Docker images
|
- name: Build Docker images
|
||||||
|
if: github.server_url != 'https://github.com' && github.ref_name == 'main'
|
||||||
run: ./scripts/ci/docker-build.sh
|
run: ./scripts/ci/docker-build.sh
|
||||||
|
|
||||||
- name: Push Docker images
|
- name: Push Docker images
|
||||||
|
if: github.server_url != 'https://github.com' && github.ref_name == 'main'
|
||||||
run: ./scripts/ci/docker-push.sh
|
run: ./scripts/ci/docker-push.sh
|
||||||
|
|
||||||
deploy-qa:
|
deploy-qa:
|
||||||
needs: build-and-push
|
needs: build-and-push
|
||||||
|
if: github.server_url != 'https://github.com' && github.ref_name == 'main'
|
||||||
runs-on: [self-hosted, qa]
|
runs-on: [self-hosted, qa]
|
||||||
env:
|
env:
|
||||||
REGISTRY: ${{ secrets.REGISTRY }}
|
REGISTRY: ${{ secrets.REGISTRY }}
|
||||||
@@ -56,6 +77,7 @@ jobs:
|
|||||||
|
|
||||||
smoke-qa:
|
smoke-qa:
|
||||||
needs: deploy-qa
|
needs: deploy-qa
|
||||||
|
if: github.server_url != 'https://github.com'
|
||||||
runs-on: [self-hosted, qa]
|
runs-on: [self-hosted, qa]
|
||||||
env:
|
env:
|
||||||
QA_ADMIN_PORT: ${{ vars.QA_ADMIN_PORT }}
|
QA_ADMIN_PORT: ${{ vars.QA_ADMIN_PORT }}
|
||||||
|
|||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -476,3 +476,6 @@ ehthumbs.db
|
|||||||
|
|
||||||
# Self-installed .NET SDK (scripts/ci/lib.sh ensure_dotnet, used when a CI runner lacks the SDK)
|
# Self-installed .NET SDK (scripts/ci/lib.sh ensure_dotnet, used when a CI runner lacks the SDK)
|
||||||
/.dotnet/
|
/.dotnet/
|
||||||
|
|
||||||
|
# Self-installed reportgenerator CLI (scripts/ci/lib.sh ensure_reportgenerator)
|
||||||
|
/.dotnet-tools/
|
||||||
|
|||||||
138
badges/coverage.svg
Normal file
138
badges/coverage.svg
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="155" height="20">
|
||||||
|
<style type="text/css">
|
||||||
|
<![CDATA[
|
||||||
|
@keyframes fade1 {
|
||||||
|
0% { visibility: visible; opacity: 1; }
|
||||||
|
23% { visibility: visible; opacity: 1; }
|
||||||
|
25% { visibility: hidden; opacity: 0; }
|
||||||
|
48% { visibility: hidden; opacity: 0; }
|
||||||
|
50% { visibility: hidden; opacity: 0; }
|
||||||
|
73% { visibility: hidden; opacity: 0; }
|
||||||
|
75% { visibility: hidden; opacity: 0; }
|
||||||
|
98% { visibility: hidden; opacity: 0; }
|
||||||
|
100% { visibility: visible; opacity: 1; }
|
||||||
|
}
|
||||||
|
@keyframes fade2 {
|
||||||
|
0% { visibility: hidden; opacity: 0; }
|
||||||
|
23% { visibility: hidden; opacity: 0; }
|
||||||
|
25% { visibility: visible; opacity: 1; }
|
||||||
|
48% { visibility: visible; opacity: 1; }
|
||||||
|
50% { visibility: hidden; opacity: 0; }
|
||||||
|
73% { visibility: hidden; opacity: 0; }
|
||||||
|
75% { visibility: hidden; opacity: 0; }
|
||||||
|
98% { visibility: hidden; opacity: 0; }
|
||||||
|
100% { visibility: hidden; opacity: 0; }
|
||||||
|
}
|
||||||
|
@keyframes fade3 {
|
||||||
|
0% { visibility: hidden; opacity: 0; }
|
||||||
|
23% { visibility: hidden; opacity: 0; }
|
||||||
|
25% { visibility: hidden; opacity: 0; }
|
||||||
|
48% { visibility: hidden; opacity: 0; }
|
||||||
|
50% { visibility: visible; opacity: 1; }
|
||||||
|
73% { visibility: visible; opacity: 1; }
|
||||||
|
75% { visibility: hidden; opacity: 0; }
|
||||||
|
98% { visibility: hidden; opacity: 0; }
|
||||||
|
100% { visibility: hidden; opacity: 0; }
|
||||||
|
}
|
||||||
|
@keyframes fade4 {
|
||||||
|
0% { visibility: hidden; opacity: 0; }
|
||||||
|
23% { visibility: hidden; opacity: 0; }
|
||||||
|
25% { visibility: hidden; opacity: 0; }
|
||||||
|
48% { visibility: hidden; opacity: 0; }
|
||||||
|
50% { visibility: hidden; opacity: 0; }
|
||||||
|
73% { visibility: hidden; opacity: 0; }
|
||||||
|
75% { visibility: visible; opacity: 1; }
|
||||||
|
98% { visibility: visible; opacity: 1; }
|
||||||
|
100% { visibility: hidden; opacity: 0; }
|
||||||
|
}
|
||||||
|
.linecoverage {
|
||||||
|
animation-duration: 15s;
|
||||||
|
animation-name: fade1;
|
||||||
|
animation-iteration-count: infinite;
|
||||||
|
}
|
||||||
|
.branchcoverage {
|
||||||
|
animation-duration: 15s;
|
||||||
|
animation-name: fade2;
|
||||||
|
animation-iteration-count: infinite;
|
||||||
|
}
|
||||||
|
.methodcoverage {
|
||||||
|
animation-duration: 15s;
|
||||||
|
animation-name: fade3;
|
||||||
|
animation-iteration-count: infinite;
|
||||||
|
}
|
||||||
|
.fullmethodcoverage {
|
||||||
|
animation-duration: 15s;
|
||||||
|
animation-name: fade4;
|
||||||
|
animation-iteration-count: infinite;
|
||||||
|
}
|
||||||
|
]]>
|
||||||
|
</style>
|
||||||
|
<title>Code coverage</title>
|
||||||
|
<defs>
|
||||||
|
<linearGradient id="gradient" x2="0" y2="100%">
|
||||||
|
<stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
|
||||||
|
<stop offset="1" stop-opacity=".1"/>
|
||||||
|
</linearGradient>
|
||||||
|
|
||||||
|
<linearGradient id="c">
|
||||||
|
<stop offset="0" stop-color="#d40000"/>
|
||||||
|
<stop offset="1" stop-color="#ff2a2a"/>
|
||||||
|
</linearGradient>
|
||||||
|
<linearGradient id="a">
|
||||||
|
<stop offset="0" stop-color="#e0e0de"/>
|
||||||
|
<stop offset="1" stop-color="#fff"/>
|
||||||
|
</linearGradient>
|
||||||
|
<linearGradient id="b">
|
||||||
|
<stop offset="0" stop-color="#37c837"/>
|
||||||
|
<stop offset="1" stop-color="#217821"/>
|
||||||
|
</linearGradient>
|
||||||
|
<linearGradient xlink:href="#a" id="e" x1="106.44" x2="69.96" y1="-11.96" y2="-46.84" gradientTransform="matrix(-.8426 -.00045 -.00045 -.8426 -94.27 -75.82)" gradientUnits="userSpaceOnUse"/>
|
||||||
|
<linearGradient xlink:href="#b" id="f" x1="56.19" x2="77.97" y1="-23.45" y2="10.62" gradientTransform="matrix(.8426 .00045 .00045 .8426 94.27 75.82)" gradientUnits="userSpaceOnUse"/>
|
||||||
|
<linearGradient xlink:href="#c" id="g" x1="79.98" x2="132.9" y1="10.79" y2="10.79" gradientTransform="matrix(.8426 .00045 .00045 .8426 94.27 75.82)" gradientUnits="userSpaceOnUse"/>
|
||||||
|
|
||||||
|
<mask id="mask">
|
||||||
|
<rect width="155" height="20" rx="3" fill="#fff"/>
|
||||||
|
</mask>
|
||||||
|
|
||||||
|
<g id="icon" transform="matrix(.04486 0 0 .04481 -.48 -.63)">
|
||||||
|
<rect width="52.92" height="52.92" x="-109.72" y="-27.13" fill="url(#e)" transform="rotate(-135)"/>
|
||||||
|
<rect width="52.92" height="52.92" x="70.19" y="-39.18" fill="url(#f)" transform="rotate(45)"/>
|
||||||
|
<rect width="52.92" height="52.92" x="80.05" y="-15.74" fill="url(#g)" transform="rotate(45)"/>
|
||||||
|
</g>
|
||||||
|
</defs>
|
||||||
|
|
||||||
|
<g mask="url(#mask)">
|
||||||
|
<rect x="0" y="0" width="90" height="20" fill="#444"/>
|
||||||
|
<rect x="90" y="0" width="20" height="20" fill="#c00"/>
|
||||||
|
<rect x="110" y="0" width="45" height="20" fill="#00B600"/>
|
||||||
|
<rect x="0" y="0" width="155" height="20" fill="url(#gradient)"/>
|
||||||
|
</g>
|
||||||
|
|
||||||
|
<g>
|
||||||
|
<path class="" stroke="#fff" d="M94 6.5 h12 M94 10.5 h12 M94 14.5 h12"/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</g>
|
||||||
|
|
||||||
|
<g fill="#fff" text-anchor="middle" font-family="Verdana,Arial,Geneva,sans-serif" font-size="11">
|
||||||
|
<a xlink:href="https://github.com/danielpalme/ReportGenerator" target="_top">
|
||||||
|
<title>Generated by: ReportGenerator 5.5.10.0</title>
|
||||||
|
<use xlink:href="#icon" transform="translate(3,1) scale(3.5)"/>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<text x="53" y="15" fill="#010101" fill-opacity=".3">Coverage</text>
|
||||||
|
<text x="53" y="14" fill="#fff">Coverage</text>
|
||||||
|
<text class="" x="132.5" y="15" fill="#010101" fill-opacity=".3">29.8%</text><text class="" x="132.5" y="14">29.8%</text>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</g>
|
||||||
|
|
||||||
|
<g>
|
||||||
|
<rect class="" x="90" y="0" width="65" height="20" fill-opacity="0"><title>Line coverage</title></rect>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 6.1 KiB |
@@ -1,5 +1,9 @@
|
|||||||
# MicCheck
|
# MicCheck
|
||||||
|
|
||||||
|
[](https://github.com/wamplerj/mic-check/actions/workflows/ci.yml)
|
||||||
|
[](https://git.wampler.us/wamplerj/mic-check/actions?workflow=ci.yml)
|
||||||
|

|
||||||
|
|
||||||
Open source feature flag management platform. Manage projects, environments, feature flags, segments, and identities across your apps.
|
Open source feature flag management platform. Manage projects, environments, feature flags, segments, and identities across your apps.
|
||||||
|
|
||||||
Built with .NET (API) and Vue.js + Vuetify (admin UI).
|
Built with .NET (API) and Vue.js + Vuetify (admin UI).
|
||||||
|
|||||||
32
scripts/ci/coverage.sh
Executable file
32
scripts/ci/coverage.sh
Executable file
@@ -0,0 +1,32 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Merges the .NET (coverlet/Cobertura) and admin (Jest/lcov) coverage output
|
||||||
|
# produced by test.sh into one report via reportgenerator, prints a summary,
|
||||||
|
# appends a build-report summary when running under Actions, and refreshes
|
||||||
|
# the coverage badge committed at badges/coverage.svg. Readme embeds that
|
||||||
|
# badge via a relative path, which resolves on both GitHub and Gitea since
|
||||||
|
# the same repo content is pushed to both remotes.
|
||||||
|
set -euo pipefail
|
||||||
|
cd "$(dirname "${BASH_SOURCE[0]}")" && source ./lib.sh
|
||||||
|
cd "$CI_ROOT"
|
||||||
|
|
||||||
|
ensure_dotnet
|
||||||
|
ensure_reportgenerator
|
||||||
|
|
||||||
|
REPORT_DIR="$CI_ROOT/coverage/report"
|
||||||
|
|
||||||
|
log "Merging coverage reports with reportgenerator"
|
||||||
|
reportgenerator \
|
||||||
|
-reports:"coverage/dotnet/**/coverage.cobertura.xml;src/admin/coverage/lcov.info" \
|
||||||
|
-targetdir:"$REPORT_DIR" \
|
||||||
|
-reporttypes:"Badges;MarkdownSummaryGithub;TextSummary"
|
||||||
|
|
||||||
|
cat "$REPORT_DIR/Summary.txt"
|
||||||
|
|
||||||
|
if [[ -n "${GITHUB_STEP_SUMMARY:-}" ]]; then
|
||||||
|
cat "$REPORT_DIR/SummaryGithub.md" >> "$GITHUB_STEP_SUMMARY"
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p "$CI_ROOT/badges"
|
||||||
|
cp "$REPORT_DIR/badge_linecoverage.svg" "$CI_ROOT/badges/coverage.svg"
|
||||||
|
|
||||||
|
log "coverage.sh complete"
|
||||||
@@ -125,6 +125,22 @@ ensure_node() {
|
|||||||
export PATH="$install_dir/bin:$PATH"
|
export PATH="$install_dir/bin:$PATH"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Installs the dotnet-reportgenerator-globaltool CLI (merges coverlet/Jest
|
||||||
|
# coverage output into badges + build-summary markdown) into $CI_ROOT/.dotnet-tools
|
||||||
|
# if it isn't already on PATH. Mirrors ensure_dotnet()/ensure_node() above.
|
||||||
|
ensure_reportgenerator() {
|
||||||
|
if command -v reportgenerator > /dev/null 2>&1; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
local tool_dir="$CI_ROOT/.dotnet-tools"
|
||||||
|
if [[ ! -x "$tool_dir/reportgenerator" ]]; then
|
||||||
|
log "reportgenerator not found on PATH; installing dotnet-reportgenerator-globaltool"
|
||||||
|
dotnet tool install dotnet-reportgenerator-globaltool --tool-path "$tool_dir"
|
||||||
|
fi
|
||||||
|
export PATH="$tool_dir:$PATH"
|
||||||
|
}
|
||||||
|
|
||||||
# The IP address on which a container published on 0.0.0.0/<gateway-ip> is
|
# The IP address on which a container published on 0.0.0.0/<gateway-ip> is
|
||||||
# reachable from a sibling container on docker's default bridge network (i.e.
|
# reachable from a sibling container on docker's default bridge network (i.e.
|
||||||
# the docker host's bridge-side address, not its public interface). Used to
|
# the docker host's bridge-side address, not its public interface). Used to
|
||||||
|
|||||||
30
scripts/ci/publish-coverage-badge.sh
Executable file
30
scripts/ci/publish-coverage-badge.sh
Executable file
@@ -0,0 +1,30 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Commits the coverage badge refreshed by coverage.sh straight back to the
|
||||||
|
# branch that triggered this run, so readme.md's relative badges/coverage.svg
|
||||||
|
# link stays current. GITHUB_SERVER_URL/GITHUB_REPOSITORY/GITHUB_REF_NAME are
|
||||||
|
# default context env vars on both GitHub Actions and Gitea Actions (Gitea's
|
||||||
|
# engine is GitHub-Actions-compatible); GITHUB_TOKEN must be passed in
|
||||||
|
# explicitly from the workflow (${{ github.token }}) on both platforms.
|
||||||
|
set -euo pipefail
|
||||||
|
cd "$(dirname "${BASH_SOURCE[0]}")" && source ./lib.sh
|
||||||
|
cd "$CI_ROOT"
|
||||||
|
|
||||||
|
[[ -n "${GITHUB_TOKEN:-}" ]] || fail "GITHUB_TOKEN env var is required to push the badge commit"
|
||||||
|
[[ -n "${GITHUB_SERVER_URL:-}" ]] || fail "GITHUB_SERVER_URL env var is required to push the badge commit"
|
||||||
|
[[ -n "${GITHUB_REPOSITORY:-}" ]] || fail "GITHUB_REPOSITORY env var is required to push the badge commit"
|
||||||
|
[[ -n "${GITHUB_REF_NAME:-}" ]] || fail "GITHUB_REF_NAME env var is required to push the badge commit"
|
||||||
|
|
||||||
|
if git diff --quiet -- badges/coverage.svg; then
|
||||||
|
log "badges/coverage.svg unchanged; nothing to publish"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
git config user.name "miccheck-ci"
|
||||||
|
git config user.email "ci@miccheck.local"
|
||||||
|
git add badges/coverage.svg
|
||||||
|
git commit -m "chore: refresh coverage badge [skip ci]"
|
||||||
|
|
||||||
|
remote_url="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
|
||||||
|
git -c http.extraheader="AUTHORIZATION: bearer ${GITHUB_TOKEN}" push "$remote_url" "HEAD:${GITHUB_REF_NAME}"
|
||||||
|
|
||||||
|
log "publish-coverage-badge.sh complete"
|
||||||
@@ -9,9 +9,10 @@ cd "$CI_ROOT"
|
|||||||
ensure_dotnet
|
ensure_dotnet
|
||||||
|
|
||||||
log "Running MicCheck.Api.Tests.Unit"
|
log "Running MicCheck.Api.Tests.Unit"
|
||||||
dotnet test tests/api/MicCheck.Api.Tests.Unit/MicCheck.Api.Tests.Unit.csproj -c Release --logger trx
|
dotnet test tests/api/MicCheck.Api.Tests.Unit/MicCheck.Api.Tests.Unit.csproj -c Release --logger trx \
|
||||||
|
--collect:"XPlat Code Coverage" --results-directory "$CI_ROOT/coverage/dotnet"
|
||||||
|
|
||||||
log "Running admin Jest tests"
|
log "Running admin Jest tests"
|
||||||
npm --prefix src/admin test
|
npm --prefix src/admin test -- --coverage --coverageReporters=lcov --coverageReporters=text-summary
|
||||||
|
|
||||||
log "test.sh complete"
|
log "test.sh complete"
|
||||||
|
|||||||
Reference in New Issue
Block a user