Setup Z3

A GitHub action to set up a specific version of the Z3 theorem prover in a GitHub Actions workflow.

Usage

To download the latest version of Z3 for the host platform and add it to the PATH environment variable for all subsequent steps in a job, add the following step to your workflow:

- name: Setup Z3
  id: z3
  uses: cda-tum/setup-z3@v1

This action creates a z3-root output variable that contains the path to the root directory of the Z3 installation and exports the Z3_ROOT environment variable for subsequent steps in a job. The output variable can be accessed as ${{ steps.z3.outputs.z3-root }}.

Specifying a version

In many cases, it is convenient to use a specific version of Z3. This can be done by specifying the version input:

- name: Setup Z3
  id: z3
  uses: cda-tum/setup-z3@v1
  with:
    version: 4.11.2

Note In order to use a specific version of Z3, the action will download the corresponding release from GitHub. This means that the version must be a valid release tag of the Z3 repository.

Specifying a platform and architecture

If you want to explicitly specify the platform and architecture for which Z3 should be downloaded (e.g., for cross-compiling to Apple Silicon), you can use the platform and architecture inputs:

- name: Setup Z3
  id: z3
  uses: cda-tum/setup-z3@v1
  with:
    platform: macOS
    architecture: arm64

Note Valid and tested combinations for the platform and architecture inputs are:

platform: linux, architecture: x64

platform: macOS, architecture: x64

platform: macOS, architecture: arm64

platform: windows, architecture: x64

Using Z3 as a library

By default, the action only adds Z3 into PATH, meaning it cannot be used as a library through its C/C++ bindings. However, if you set add_to_library_path to true, the action also populates other environment variables (depending on the chosen platform) which ensure that you can build other libraries that link against Z3.

- name: Setup Z3
  id: z3
  uses: cda-tum/setup-z3@v1
  with:
    add_to_library_path: true