Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgv/zig-project-template
https://github.com/dgv/zig-project-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/dgv/zig-project-template
- Owner: dgv
- License: mit
- Created: 2024-06-15T02:13:26.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T02:54:48.000Z (4 months ago)
- Last Synced: 2024-08-28T03:56:26.603Z (4 months ago)
- Language: Zig
- Homepage:
- Size: 2.26 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zig-project-template
[](https://ziglang.org/)
[](http://dgv.dev.br/zig-project-template/)
[](https://github.com/dgv/zig-project-template/actions/workflows/build.yml)
[](https://codecov.io/gh/dgv/zig-project-template)
[](https://opensource.org/licenses/MIT)
### Badges Roadmap
- [X] [zig version](#version)
- [X] [zig doc](#cocumentation)
- [X] [continuos integration](#continuos-integration)
- [X] [code coverage](#code-coverage)
- [X] [license](#license)
### Version
On Zig 0.12.0 [`minimum_zig_version`](https://github.com/dgv/zig-project-template/blob/main/build.zig.zon#L15-L18) was introduced by [Zon](https://zig.news/edyu/zig-package-manager-wtf-is-zon-558e), show this reference in a badge can be pretty useful to determine compatibility.
```zig
// 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
Documentation can be generated using `-femit-docs` flag or as step on `build.zig`:
```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/
### Continuos Integration
Using following configuration with [Github Actions Matrix](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs) and [build-zig](https://github.com/marketplace/actions/setup-zig):
```yaml
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 }}
```
https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge
### Code Coverage
We can use [kconv](https://github.com/SimonKagstrom/kcov) integrated on `build.zig` during the tests with `-Dcoverage=true` flag, then submit the generated results on `cover` directorty to [codeconv](https://github.com/SimonKagstrom/kcov/blob/master/doc/codecov.md) using uploader utility adding following steps:
[build.zig](https://github.com/dgv/zig-project-template/blob/main/build.zig.zon#L15-L18)
```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);
}
```
[build.yml](https://github.com/dgv/zig-project-template/blob/main/.github/workflows/build.yml#L36-L53)
```yaml
- 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](https://github.com/liyu1981/kcov/tree/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
### License
You can just use [Markdown License badges](https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba) as reference.