liza

Command-line 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

Module

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

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

1. 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.
      • Common steps execution (see below).
      • Common optional steps execution, except for check (see below).
    • run: Zig executable run.
    • 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.
      • Common steps execution (see below).
      • Common optional steps execution, except for check (see below).
    • run: Example run.

• 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 steps execution (see below).

• Mach Application Template (app):

  • WGSL shader usage.
  • Build steps:
    • install (default):
      • Mach executable installation.
      • Common steps execution (see below).
    • run: Mach executable run.

• Common Build Steps:

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

• Common Optional Build Steps:

  • doc ($d): Documentation emission (--add-doc).
  • cov ($c): Code coverage generation (--add-cov).
  • check ($k): Compilation check for ZLS Build-On-Save (--add-check).

• GitHub / Forgejo / Woodpecker CI Workflow Template Jobs:

  • install:
    • Main artifacts' installation.
    • test: Test suite execution.
    • fmt: Formatting check execution.
  • (GitHub-only) cov: Either exe's or lib's code coverage publication to Codecov (--add-cov).

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

  • 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 Jobs:

  • 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.