liza

Command-line Zig codebase initializer.

Usage

Executable

• Build from source:

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

• Download latest release:

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

Module

1. Add liza dependency to build.zig.zon:

zig fetch --save git+https://codeberg.org/tensorush/liza.git

2. Use liza dependency in build.zig:

const liza_dep = b.dependency("liza", .{
    .target = target,
    .optimize = optimize,
});
const liza_mod = liza_dep.module("liza");
<std.Build.Step.Compile>.root_module.addImport("liza", liza_mod);

Features

• Zig Executable Template (exe):

  • Public API module creation.
  • Dependency package usage.
  • Build steps:
    • install (default):
      • Zig executable installation.
      • All-step execution, except for run, check, and release.
    • run: Zig executable run.
    • doc ($d): Documentation emission (--add-doc).
    • test: Test suite execution.
    • cov ($c): Code coverage generation (--add-cov).
    • fmt: Formatting check execution.
    • check ($s): Compilation check for ZLS Build-On-Save (--add-check).
    • release: Release binaries' installation and archiving.

• Zig Library Template (lib):

  • Public root module creation.
  • Build steps:
    • install (default):
      • Zig static library installation.
      • Example suite installation.
      • All-step execution, except for run and check.
    • doc ($d): Documentation emission (--add-doc).
    • run: Example run.
    • test: Test suite execution.
    • cov ($c): Code coverage generation (--add-cov).
    • fmt: Formatting check execution.
    • check ($s): Compilation check for ZLS Build-On-Save (--add-check).

• 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.
      • All-step execution.
    • test: Test suite execution.
    • fmt: Formatting check execution.

• Mach Application Template (app):

  • WGSL shader usage.
  • Build steps:
    • install (default):
      • Mach executable installation.
      • All-step execution, except for run.
    • run: Mach executable run.
    • test: Test suite execution.
    • fmt: Formatting check execution.

• GitHub / Forgejo / Woodpecker CI Workflow Template:

  • run/example/lib/exe ($s): either exe's executable run, lib's example suite execution, bld's library installation, or app's executable installation.
  • test: Test suite execution and either exe's or lib's GitHub-only code coverage publication to Codecov (--add-cov).
  • fmt: Formatting check execution.

• GitHub / Forgejo / Woodpecker CD Workflow Template (--add-doc):

  • emit→deploy: either exe's or lib's documentation emission and deployment to GitHub Pages or Codeberg Pages:
    • (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:

  • release: exe's 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: Code coverage artifacts.

• .gitattributes.