Commit 595397dbeb17305d50f5995871fc2bf8f0377580 | zig

author	Andrew Kelley <andrew@ziglang.org> 2020-12-31 01:15:18-08:00
committer	GitHub <noreply@github.com> 2020-12-31 01:15:18-08:00
log	595397dbeb17305d50f5995871fc2bf8f0377580
tree	30be44e83cc24bbf884a9abae2f7eec075cd5aba
parent	7550af0d4c215409f11a3e758d073d21ae17a2b7
parent	02438aabe3a04ac8ca2a2e0b2501ba18885652e3
signature	Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #7601 from jayschwa/stage2-semver

stage2: SemVer compliance for development builds

3 files changed, 44 insertions(+), 25 deletions(-)

CMakeLists.txt
build.zig
src
- config.zig.in

CMakeLists.txt+3-3

build.zig+40-16

 @@ -11,7 +11,7 @@ const fs = std.fs;
 const InstallDirectoryOptions = std.build.InstallDirectoryOptions;
 const assert = std.debug.assert;
-const zig_version = std.builtin.Version{ .major = 0, .minor = 7, .patch = 1 };
+const zig_version = std.builtin.Version{ .major = 0, .minor = 8, .patch = 0 };
 pub fn build(b: *Builder) !void {
     b.setPreferredReleaseMode(.ReleaseFast);
 @@ -227,24 +227,48 @@ pub fn build(b: *Builder) !void {
         const version_string = b.fmt("{}.{}.{}", .{ zig_version.major, zig_version.minor, zig_version.patch });
         var code: u8 = undefined;
-        const git_sha_untrimmed = b.execAllowFail(&[_][]const u8{
+        const git_describe_untrimmed = b.execAllowFail(&[_][]const u8{
-            "git",    "-C",          b.build_root,     "name-rev", "HEAD",
+            "git", "-C", b.build_root, "describe", "--match", "*.*.*", "--tags",
-            "--tags", "--name-only", "--no-undefined", "--always",
         }, &code, .Ignore) catch {
             break :v version_string;
         };
-        const git_sha_trimmed = mem.trim(u8, git_sha_untrimmed, " \n\r");
+        const git_describe = mem.trim(u8, git_describe_untrimmed, " \n\r");
-        // This will look like e.g. "0.7.0^0" for a tag commit.
+        switch (mem.count(u8, git_describe, "-")) {
-        if (mem.endsWith(u8, git_sha_trimmed, "^0")) {
+            0 => {
-            const git_ver_string = git_sha_trimmed[0 .. git_sha_trimmed.len - 2];
+                // Tagged release version (e.g. 0.7.0).
-            if (!mem.eql(u8, git_ver_string, version_string)) {
+                if (!mem.eql(u8, git_describe, version_string)) {
-                std.debug.print("Expected git tag '{}', found '{}'\n", .{ version_string, git_ver_string });
+                    std.debug.print("Zig version '{}' does not match Git tag '{}'\n", .{ version_string, git_describe });
-                std.process.exit(1);
+                    std.process.exit(1);
-            }
+                }
-            break :v b.fmt("{}", .{version_string});
+                break :v version_string;
-        } else {
+            },
-            break :v b.fmt("{}+{}", .{ version_string, git_sha_trimmed });
+            2 => {
+                // Untagged development build (e.g. 0.7.0-684-gbbe2cca1a).
+                var it = mem.split(git_describe, "-");
+                const tagged_ancestor = it.next() orelse unreachable;
+                const commit_height = it.next() orelse unreachable;
+                const commit_id = it.next() orelse unreachable;
+                const ancestor_ver = try std.builtin.Version.parse(tagged_ancestor);
+                if (zig_version.order(ancestor_ver) != .gt) {
+                    std.debug.print("Zig version '{}' must be greater than tagged ancestor '{}'\n", .{ zig_version, ancestor_ver });
+                    std.process.exit(1);
+                }
+                // Check that the commit hash is prefixed with a 'g' (a Git convention).
+                if (commit_id.len < 1 or commit_id[0] != 'g') {
+                    std.debug.print("Unexpected `git describe` output: {}\n", .{git_describe});
+                    break :v version_string;
+                }
+                // The version is reformatted in accordance with the https://semver.org specification.
+                break :v b.fmt("{}-dev.{}+{}", .{ version_string, commit_height, commit_id[1..] });
+            },
+            else => {
+                std.debug.print("Unexpected `git describe` output: {}\n", .{git_describe});
+                break :v version_string;
+            },
         }
     };
     exe.addBuildOption([:0]const u8, "version", try b.allocator.dupeZ(u8, version));

src/config.zig.in+1-6

 @@ -1,11 +1,6 @@
 pub const have_llvm = true;
 pub const version: [:0]const u8 = "@ZIG_VERSION@";
-pub const semver: @import("std").SemanticVersion = .{
+pub const semver = try @import("std").SemanticVersion.parse(version);
-    .major = @ZIG_VERSION_MAJOR@,
-    .minor = @ZIG_VERSION_MINOR@,
-    .patch = @ZIG_VERSION_PATCH@,
-    .build = "@ZIG_GIT_REV@",
-};
 pub const log_scopes: []const []const u8 = &[_][]const u8{};
 pub const zir_dumps: []const []const u8 = &[_][]const u8{};
 pub const enable_tracy = false;

...	@@ -44,9 +44,9 @@ if("${ZIG_VERSION}" STREQUAL "")	...	@@ -44,9 +44,9 @@ if("${ZIG_VERSION}" STREQUAL "")
44	# Tagged release version.	44	# Tagged release version.
45	set(GIT_TAG ${CMAKE_MATCH_1})	45	set(GIT_TAG ${CMAKE_MATCH_1})
46	if(NOT GIT_TAG VERSION_EQUAL ZIG_VERSION)	46	if(NOT GIT_TAG VERSION_EQUAL ZIG_VERSION)
47	message(SEND_ERROR "Configured Zig version (${ZIG_VERSION}) does not match Git tag (${GIT_TAG}).")	47	message(SEND_ERROR "Zig version (${ZIG_VERSION}) does not match Git tag (${GIT_TAG}).")
48	endif()	48	endif()
49	elseif(GIT_DESCRIBE MATCHES "^v?([0-9]+\\.[0-9]+\\.[0-9]+)-([0-9]+)-(.+)$")	49	elseif(GIT_DESCRIBE MATCHES "^v?([0-9]+\\.[0-9]+\\.[0-9]+)-([0-9]+)-g(.+)$")
50	# Untagged pre-release. The Zig version is updated to include the number of commits	50	# Untagged pre-release. The Zig version is updated to include the number of commits
51	# since the last tagged version and the commit hash. The version is formatted in	51	# since the last tagged version and the commit hash. The version is formatted in
52	# accordance with the https://semver.org specification.	52	# accordance with the https://semver.org specification.
...	@@ -54,7 +54,7 @@ if("${ZIG_VERSION}" STREQUAL "")	...	@@ -54,7 +54,7 @@ if("${ZIG_VERSION}" STREQUAL "")
54	set(GIT_COMMITS_AFTER_TAG ${CMAKE_MATCH_2})	54	set(GIT_COMMITS_AFTER_TAG ${CMAKE_MATCH_2})
55	set(GIT_COMMIT ${CMAKE_MATCH_3})	55	set(GIT_COMMIT ${CMAKE_MATCH_3})
56	if(NOT ZIG_VERSION VERSION_GREATER GIT_TAG)	56	if(NOT ZIG_VERSION VERSION_GREATER GIT_TAG)
57	message(SEND_ERROR "Configured Zig version (${ZIG_VERSION}) must be greater than tagged ancestor (${GIT_TAG}).")	57	message(SEND_ERROR "Zig version (${ZIG_VERSION}) must be greater than tagged ancestor (${GIT_TAG}).")
58	endif()	58	endif()
59	set(ZIG_VERSION "${ZIG_VERSION}-dev.${GIT_COMMITS_AFTER_TAG}+${GIT_COMMIT}")	59	set(ZIG_VERSION "${ZIG_VERSION}-dev.${GIT_COMMITS_AFTER_TAG}+${GIT_COMMIT}")
60	else()	60	else()