liza

Zig codebase initializer.

Usage

Executable

• Build from source:

git clone https://codeberg.org/tensorush/liza.git
cd liza/
zig build run -- -h

• Download latest release:

wget https://github.com/tensorush/liza/releases/latest/download/<archive>
tar -xf <archive> # Unix
unzip <archive> # Windows
./<binary> -h

Features

• Zig Executable Template (exe):

  • Public API module creation.
  • Dependency package usage.
  • Build steps:
    • install (default):
      • Zig executable installation.
      • Common build steps execution (see below).
    • run: Zig executable run.
    • Custom build steps (see below).
    • Optional build steps (see below).
  • Common build options exposure (see below).

• Zig Library Template (lib):

  • Public root module creation.
  • Build steps:
    • install (default):
      • Zig static library installation.
      • Common build steps execution (see below).
    • run: Example suite execution.
    • Custom build steps, except release (see below).
    • Optional build steps (see below).
  • Common build options exposure (see below).

• Zig Build Template (bld):

  • Public Translate-C module creation.
  • Lazy dependency package usage.
  • Configuration option usage.
  • Build steps:
    • install (default):
      • C/C++ static library installation.
      • Common build steps execution (see below).

• Common Build Steps:

  • test: Test suite execution.
  • fmt: Formatting check execution.

• Custom Build Steps:

  • tag: Next version tag with Zq.
  • update: Dependencies and minimum Zig version update with Zq.
  • release: Archived binary release with Tar (Unix) and Zip (Windows).

• Optional Build Steps:

  • doc ($d): Documentation emission (-d, doc).
  • cov ($c): Kcov source code coverage generation (-c, cov).
  • lint ($l): Vale markup prose linting check execution (-l, lint).
  • spell ($s): Typos source code spelling check execution (-s, spell).
  • check ($k): Build compilation check for ZLS Build-On-Save (-k, check).

• Common Build Options:

  • -Ddebug: Test suite execution under LLDB debugger.
  • -Dstrip: Compilation without stack trace printing code.
  • -Dprofile: Compilation with Tracy profiler Zig bindings support.
  • -Dno-bin -fincremental --watch: Incremental compilation without binary emission.

• GitHub / Forgejo / Woodpecker CI Workflow Template Jobs:

  • install:
    • Main artifacts' installation.
    • test: Test suite execution.
    • fmt: Formatting check execution.
    • (GitHub-only) cov ($c): Kcov source code coverage publication to Codecov (-c, cov).

• GitHub / Forgejo / Woodpecker CD Workflow Template Jobs:

  • (exe-/lib-only) emit→deploy: Documentation emission and deployment to GitHub Pages or Codeberg Pages (-d, doc):
    • (Woodpecker-only) Generate Codeberg access token with repository:write permission and add it as TOKEN secret available on Push event.
    • (Woodpecker-only) Add email as EMAIL secret available on Push event.

• GitHub / Woodpecker Release Workflow Jobs:

  • (exe-only) release: Release publication using minisign:
    • Generate key pair without password: minisign -GW.
    • Add ./minisign.pub as MINISIGN_PUBLIC_KEY secret (available on Tag event in Woodpecker).
    • Add ~/.minisign/minisign.key as MINISIGN_SECRET_KEY secret (available on Tag event in Woodpecker).
    • (Woodpecker-only) Generate Codeberg access token with misc:read and repository:write permissions and add it as TOKEN secret available to woodpeckerci/plugin-release on Tag event.

• MIT License Template:

  • $y: Current year.
  • $n: User name.

• .gitignore Template:

  • $c: Kcov source code coverage artifacts (-c, cov).

• .gitattributes.