Skip to content

Add a friendly error message when Zig version is too old or too recent #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a friendly error message when Zig version is too old or too recent #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fca270
feat: friendly error message when Zig version is too old or too recent
Gbkng Jul 25, 2025
a261024
fix: add pre to minimum required version of Zig
Gbkng Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,38 @@ pub fn build(b: *std.Build) void {
release.dependOn(&install.step);
}
}

const builtin = @import("builtin");
comptime { // check current Zig version is compatible
const min: std.SemanticVersion = .{ .major = 0, .minor = 15, .patch = 0, .pre = "dev" }; // .pre and .build default to null
const max: std.SemanticVersion = .{ .major = 0, .minor = 15, .patch = 0 };
const current = builtin.zig_version;
if (current.order(min) == .lt) {
const error_message =
\\Your version of zig is too old ({d}.{d}.{d}).
\\This project requires Zig minimum version {d}.{d}.{d}.
;
@compileError(std.fmt.comptimePrint(error_message, .{
current.major,
current.minor,
current.patch,
min.major,
min.minor,
min.patch,
}));
}
if (current.order(max) == .gt) {
const error_message =
\\Your version of zig is too recent ({d}.{d}.{d}).
\\This project requires Zig maximum version to be {d}.{d}.{d}.
;
@compileError(std.fmt.comptimePrint(error_message, .{
current.major,
current.minor,
current.patch,
max.major,
max.minor,
max.patch,
}));
}
}