repository·main·Indexed 19 days ago
https://github.com/ziglang/www.ziglang.orgSource code and content for the official Zig programming language website. Built with the Zine static site generator, the repository includes documentation on running the site locally, contributing translations, and technical requirements for hosting community mirrors, including tarball filename parsing and integrity verification.
The check-mirrors utility is a tool used to verify the integrity and functionality of community Zig mirrors. It ensures that mirrors are serving correct content by fetching a subset of available tarballs and signatures from each mirror and comparing them against the files served by the official ziglang.org.
This check is automated via a daily workflow and is also triggered whenever a Pull Request modifies the mirror list.
Mirrors must parse filenames to determine if a request is for a 'normal' release or a 'pre-release' version.
zig-VERSION.EXTzig-bootstrap-VERSION.EXTzig-ARCH-OS-VERSION.EXTzig-OS-ARCH-VERSION.EXT (Legacy/Older versions only)Where VERSION is a SemVer string (e.g., 0.14.1 or 0.15.0-dev.671+c907866d5), EXT is .tar.xz, .zip, .tar.xz.minisig, or .zip.minisig.
Use the following regex to validate the name and capture the version string in a single group:
^zig(?:|-bootstrap|-[a-zA-Z0-9_]+-[a-zA-Z0-9_]+)-(\d+\.\d+\.\d+(?:-dev\.\d+\+[0-9a-f]+)?)\.(?:tar\.xz|zip)(?:\.minisig)?$zig-..tar.xz, .zip, .tar.xz.minisig, .zip.minisig).-. If that byte is followed by dev, find the previous occurrence of - instead.- (and before the extension) is the version.^zig(?:|-bootstrap|-[a-zA-Z0-9_]+-[a-zA-Z0-9_]+)-(\d+\.\d+\.\d+(?:-dev\.\d+\+[0-9a-f]+)?)\.(?:tar\.xz|zip)(?:\.minisig)?$Adding a new language translation involves several steps. Refer to the Zine documentation for content and templating syntax, and the i18n section for localization specifics.
A complete translation requires:
build.zig and creating its corresponding content directory.Ziggy file under i18n/ that contains the localized version of every phrase used on the site.news and devlog files should not be translated).Once your mirror meets all technical requirements, you can add it to the official list by:
assets/community-mirrors.ziggy..url, .username, and .email.Example entry format:
+ {
+ .url = "https://mymirror.net",
+ .username = "my-github-username",
+ .email = "my@email.com",
+ },[
{
.url = "https://a.com",
.username = "a",
.email = "a@a.com",
},
{
.url = "https://b.com/zig",
.username = "b",
.email = "b@b.com",
},
+ {
+ .url = "https://mymirror.net",
+ .username = "my-github-username",
+ .email = "my@email.com",
+ },
]Some code examples on the website require the following system dependencies to function correctly:
tarzlibjqOn Windows, it is recommended to use WSL to manage these dependencies.
The website uses Zine for static site generation. To run the site locally, ensure you have the correct version of Zig installed (Zine and the website code samples target the latest tagged release of Zig). You can use zigup to manage multiple Zig versions easily. Once Zig is configured, use the Zig build system to serve the site.
zig build serveIf you wish to host a community mirror for Zig tarballs, your service must adhere to the following technical requirements:
X must start with https:// and support valid signed certificates.https://ziglang.org/ (or a valid mirror of it).https://ziglang.org/.0.14.1), serve files from https://ziglang.org/download/<version>/<filename>.0.15.0-dev.671...), serve files from https://ziglang.org/builds/<filename>.404 Not Found: May be used if the filename doesn't match the expected schema or if a version is too old (e.g., $\le$ 0.5.0).504 Gateway Timeout: Should be used if the upstream https://ziglang.org/ fails or times out.429 Too Many Requests: Should be used for rate-limiting.503 Service Unavailable: Should be used during scheduled maintenance.source query parameter (e.g., ?source=github-mlugg-setup-zig) to identify traffic origins.When writing tests that require dynamic memory allocation, use std.testing.allocator instead of a general-purpose allocator. This specialized allocator is designed to catch memory leaks and use-after-free errors specifically during the testing process.
var list = std.ArrayList(i32).init(std.testing.allocator);To read a structured header from standard input, use std.io.getStdIn().reader().readStruct and pass the target struct type (e.g., Protocol.Header). This is useful for implementing binary protocols where a fixed-size header precedes the payload.
```zig
const std = @import(This example demonstrates how to locate the directory where the current executable resides, open it, and read a file (e.g., word.txt) using an ArenaAllocator for memory management. This pattern is useful for accessing bundled assets or configuration files that are shipped alongside your binary.
const std = @import("std");
pub fn main() !void {
// Initialize an ArenaAllocator for easy memory management
var arena_state = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena_state.deinit();
const arena = arena_state.allocator();
// Get the directory where the current executable is located
const self_exe_dir_path = try std.fs.selfExeDirPathAlloc(arena);
var self_exe_dir = try std.fs.cwd().openDir(self_exe_dir_path, .{});
defer self_exe_dir.close();
// Read a file named 'word.txt' from that directory
const word = try self_exe_dir.readFileAlloc(arena, "word.txt", 1000);
// Setup buffered stdout
var stdout_buffer: [1000]u8 = undefined;
var stdout_writer = std.fs.File.stdout().writer(&stdout_buffer);
const stdout = &stdout_writer.interface;
try stdout.print("Hello {s}\n", .{word});
try stdout.flush();
}In Zig, you can use build-time configuration (often provided via an imported config module) to control code execution and compilation. This allows you to:
std.SemanticVersion.parse on a configuration string and check its properties (like major, minor, patch) within main or at compile-time using @compileError to prevent compilation if requirements aren't met.config.have_libfoo) inside if blocks to conditionally call functions or include logic that depends on external dependencies or specific build settings.const std = @import("std");
const config = @import("config");
// Parse version from config for validation
const semver = std.SemanticVersion.parse(config.version) catch unreachable;
extern fn foo_bar() void;
pub fn main() !void {
// Enforce version constraints
if (semver.major < 1) {
@compileError("too old");
}
std.debug.print("version: {s}\n", .{config.version});
// Conditionally execute code based on build config
if (config.have_libfoo) {
foo_bar();
}
}