From 185a0ff8c49910f16e4a7d0ea9f412bd83cadfd7 Mon Sep 17 00:00:00 2001 From: Jonathan Marler Date: Sat, 17 Aug 2024 19:29:26 -0600 Subject: [PATCH] doc: clarify build.zig.zon urls should point to immutable data There's been some proliferation of dependency URLs that reference mutable data such as links to git branches that can change. This has resulted in broken projects, i.e. * https://github.com/RohanVashisht1234/raylib_rain_train/blob/9eef9de94c511f2eb4fe5db1d6abd574ee245c9b/build.zig.zon * https://github.com/rcmagic/ZigFightingGame/commit/4b64353e9c69de0fa2eb87fa9c3a3da76a8a3e7b There's also disagreement about whether it's fine for URL's to point to git branches, i.e. https://github.com/Not-Nik/raylib-zig/pull/130 This updates the docs to clarify that urls should reference immutable data. --- doc/build.zig.zon.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/build.zig.zon.md b/doc/build.zig.zon.md index d0740a923760..9116ab17d2e7 100644 --- a/doc/build.zig.zon.md +++ b/doc/build.zig.zon.md @@ -47,7 +47,8 @@ String. When updating this field to a new URL, be sure to delete the corresponding `hash`, otherwise you are communicating that you expect to find the old hash at -the new URL. +the new URL. The URL should always result in the same content, avoid URL's that +reference content that can change such as git branch names. #### `hash`