setup-zig/README.md
2022-11-07 13:38:56 +01:00

1.2 KiB

setup-zig

Use the zig compiler in your Github Actions workflows

Usage - License: Apache-2.0

Usage

In a Github Actions workflow file, do something like:

jobs:
  test:
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    runs-on: ${{matrix.os}}
    steps:
      - uses: actions/checkout@v2
      - uses: goto-bus-stop/setup-zig@v2
      - run: zig build test
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: goto-bus-stop/setup-zig@v2
      - run: zig fmt --check src/*.zig

Optionally set a Zig version:

- uses: goto-bus-stop/setup-zig@v2
  with:
    version: 0.7.0

The default is to use the nightly master builds.

Or pin to a specific commit using version+commithash syntax:

- uses: goto-bus-stop/setup-zig@v2
  with:
    version: 0.6.0+4b48fccad

If you are running Zig on Windows machines, you need to make sure that your .zig files use \n line endings and not \r\n. The actions/checkout action auto-converts line endings to \r\n on Windows runners, so add a .gitattributes file:

*.zig text eol=lf

License

Apache-2.0