On Zig 0.12.0 minimum_zig_version was introduced by Zon, show this reference in a badge can be pretty useful to determine compatibility.
// This field is optional.
// This is currently advisory only; Zig does not yet do anything
// with this value.
.minimum_zig_version = "0.12.0",Documentation can be generated using -femit-docs flag or as step on build.zig:
const docs = b.addInstallDirectory(.{
.source_dir = lib.getEmittedDocs(),
.install_dir = .prefix,
.install_subdir = "../docs",
});
b.getInstallStep().dependOn(&docs.step);https://ziglang.org/documentation/master/#Comments
https://sudw1n.gitlab.io/posts/zig-build-docs/
Using following configuration with Github Actions Matrix and build-zig:
name: build
on:
push:
branches: [main]
pull_request:
branches: [main]
schedule:
- cron: 0 9 * * *
jobs:
test:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
include:
- os: windows-latest
crlf: fix
- os: ubuntu-latest
coverage: -Dtest-coverage=true
runs-on: ${{matrix.os}}
steps:
- name: Force Line Endings for Windows
if: ${{ matrix.crlf }}
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- name: Checkout
uses: actions/checkout@v3
- name: Setup Zig
uses: goto-bus-stop/setup-zig@v2
with:
version: master
- name: Run Tests
run: |
zig version
zig build test -Dcomptime-tests=false ${{ matrix.coverage }}We can use kconv integrated on build.zig during the tests with -Dcoverage=true flag, then submit the generated results on cover directorty to codeconv using uploader utility adding following steps:
build.zig
// Converage step to generate debug messages for codecov using kcov
const coverage = b.option(bool, "coverage", "Generate test coverage") orelse false;
if (coverage) {
const run_cover = b.addSystemCommand(&.{
"kcov",
"--clean",
"--include-pattern=src/",
"cover",
});
run_cover.addArtifactArg(exe_unit_tests);
run_exe_unit_tests.step.dependOn(&run_cover.step);
}- name: Download kcov
if: ${{ matrix.os == 'ubuntu-latest' }}
run: |
sudo apt-get install -y kcov
...
- name: Upload Codecov
if: ${{ matrix.os == 'ubuntu-latest' }}
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
run: |
curl -Os https://uploader.codecov.io/latest/linux/codecov
chmod +x codecov
./codecov -t ${CODECOV_TOKEN}Better converage analysis is possible using kcov-zig fork, wip...
https://zig.news/squeek502/code-coverage-for-zig-1dk1
https://zig.news/liyu1981/tiny-change-to-kcov-for-better-covering-zig-hjm
You can just use Markdown License badges as reference.