commit 7fa2357d0586cef742bf691d69a6cffdd353b496 (tree)
parent cb77bd672c3b398e3c5f6be80af03243bf8638e3
Author: Andrew Kelley <andrew@ziglang.org>
Date: Fri, 10 May 2024 16:27:30 -0700
Merge pull request #19349 from nolanderc/save-commit
`zig fetch`: resolve branch/tag names to commit SHA
Diffstat:
2 files changed, 51 insertions(+), 3 deletions(-)
diff --git a/src/Package/Fetch.zig b/src/Package/Fetch.zig
@@ -44,6 +44,8 @@ omit_missing_hash_error: bool,
/// which specifies inclusion rules. This is intended to be true for the first
/// fetch task and false for the recursive dependencies.
allow_missing_paths_field: bool,
+/// If true and URL points to a Git repository, will use the latest commit.
+use_latest_commit: bool,
// Above this are fields provided as inputs to `run`.
// Below this are fields populated by `run`.
@@ -59,6 +61,8 @@ actual_hash: Manifest.Digest,
has_build_zig: bool,
/// Indicates whether the task aborted due to an out-of-memory condition.
oom_flag: bool,
+/// If `use_latest_commit` was true, this will be the commit that was used.
+latest_commit: ?git.Oid,
// This field is used by the CLI only, untouched by this file.
@@ -699,6 +703,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {
.job_queue = f.job_queue,
.omit_missing_hash_error = false,
.allow_missing_paths_field = true,
+ .use_latest_commit = false,
.package_root = undefined,
.error_bundle = undefined,
@@ -707,6 +712,7 @@ fn queueJobsForDeps(f: *Fetch) RunError!void {
.actual_hash = undefined,
.has_build_zig = false,
.oom_flag = false,
+ .latest_commit = undefined,
.module = null,
};
@@ -994,7 +1000,9 @@ fn initResource(f: *Fetch, uri: std.Uri, server_header_buffer: []u8) RunError!Re
}
return f.fail(f.location_tok, try eb.printString("ref not found: {s}", .{want_ref}));
};
- if (uri.fragment == null) {
+ if (f.use_latest_commit) {
+ f.latest_commit = want_oid;
+ } else if (uri.fragment == null) {
const notes_len = 1;
try eb.addRootErrorMessage(.{
.msg = try eb.addString("url field is missing an explicit ref"),
diff --git a/src/main.zig b/src/main.zig
@@ -5097,6 +5097,7 @@ fn cmdBuild(gpa: Allocator, arena: Allocator, args: []const []const u8) !void {
.job_queue = &job_queue,
.omit_missing_hash_error = true,
.allow_missing_paths_field = false,
+ .use_latest_commit = false,
.package_root = undefined,
.error_bundle = undefined,
@@ -5105,6 +5106,7 @@ fn cmdBuild(gpa: Allocator, arena: Allocator, args: []const []const u8) !void {
.actual_hash = undefined,
.has_build_zig = true,
.oom_flag = false,
+ .latest_commit = undefined,
.module = build_mod,
};
@@ -6894,6 +6896,7 @@ const usage_fetch =
\\ --debug-hash Print verbose hash information to stdout
\\ --save Add the fetched package to build.zig.zon
\\ --save=[name] Add the fetched package to build.zig.zon as name
+ \\ --preserve-url Store a verbatim copy of the URL in build.zig.zon
\\
;
@@ -6909,6 +6912,7 @@ fn cmdFetch(
var override_global_cache_dir: ?[]const u8 = try EnvVar.ZIG_GLOBAL_CACHE_DIR.get(arena);
var debug_hash: bool = false;
var save: union(enum) { no, yes, name: []const u8 } = .no;
+ var preserve_url: bool = false;
{
var i: usize = 0;
@@ -6929,6 +6933,8 @@ fn cmdFetch(
save = .yes;
} else if (mem.startsWith(u8, arg, "--save=")) {
save = .{ .name = arg["--save=".len..] };
+ } else if (mem.startsWith(u8, arg, "--preserve-url")) {
+ preserve_url = true;
} else {
fatal("unrecognized parameter: '{s}'", .{arg});
}
@@ -6940,6 +6946,8 @@ fn cmdFetch(
}
}
+ if (preserve_url and save == .no) fatal("use of '--preserve-url' requires '--save'", .{});
+
const path_or_url = opt_path_or_url orelse fatal("missing url or path parameter", .{});
var thread_pool: ThreadPool = undefined;
@@ -6988,6 +6996,7 @@ fn cmdFetch(
.job_queue = &job_queue,
.omit_missing_hash_error = true,
.allow_missing_paths_field = false,
+ .use_latest_commit = true,
.package_root = undefined,
.error_bundle = undefined,
@@ -6996,6 +7005,7 @@ fn cmdFetch(
.actual_hash = undefined,
.has_build_zig = false,
.oom_flag = false,
+ .latest_commit = undefined,
.module = null,
};
@@ -7052,13 +7062,43 @@ fn cmdFetch(
var fixups: Ast.Fixups = .{};
defer fixups.deinit(gpa);
+ var saved_path_or_url = path_or_url;
+
+ if (fetch.latest_commit) |*latest_commit| {
+ var uri = try std.Uri.parse(path_or_url);
+ const target_ref = uri.fragment orelse "";
+ if (!std.mem.eql(u8, target_ref, latest_commit)) {
+ std.log.info("resolved ref '{s}' to commit {s}", .{
+ target_ref,
+ std.fmt.fmtSliceHexLower(latest_commit),
+ });
+
+ if (!preserve_url) {
+ if (target_ref.len != 0) {
+ // include the target ref in a query parameter
+ var query = try std.ArrayList(u8).initCapacity(arena, 4 + target_ref.len);
+ try std.Uri.writeEscapedQuery(query.writer(), "ref=");
+ try std.Uri.writeEscapedQuery(query.writer(), target_ref);
+ uri.query = try query.toOwnedSlice();
+ }
+
+ // replace the refspec with the resolved commit SHA
+ uri.fragment = try std.fmt.allocPrint(arena, "{}", .{
+ std.fmt.fmtSliceHexLower(latest_commit),
+ });
+
+ saved_path_or_url = try std.fmt.allocPrint(arena, "{}", .{uri});
+ }
+ }
+ }
+
const new_node_init = try std.fmt.allocPrint(arena,
\\.{{
\\ .url = "{}",
\\ .hash = "{}",
\\ }}
, .{
- std.zig.fmtEscapes(path_or_url),
+ std.zig.fmtEscapes(saved_path_or_url),
std.zig.fmtEscapes(&hex_digest),
});
@@ -7078,7 +7118,7 @@ fn cmdFetch(
if (dep.hash) |h| {
switch (dep.location) {
.url => |u| {
- if (mem.eql(u8, h, &hex_digest) and mem.eql(u8, u, path_or_url)) {
+ if (mem.eql(u8, h, &hex_digest) and mem.eql(u8, u, saved_path_or_url)) {
std.log.info("existing dependency named '{s}' is up-to-date", .{name});
process.exit(0);
}
