Added zig feature

Roemer · Roemer · commit b710da473dd3 · 2025-08-12T20:53:36.000Z
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,7 +14,7 @@ jobs:
   build:
     strategy:
       matrix:
-        feature: ["go"]
+        feature: ["go", "zig"]
     runs-on: ubuntu-latest
     permissions:
       contents: read
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ Below is a list with included features, click on the link for more details.
 | Name | Description |
 | --- | --- |
 | [go](./features/src/go/README.md) | A feature which installs Go. |
+| [zig](./features/src/zig/README.md) | A feature which installs Zig. |
 
 ## Usage
 
diff --git a/build/build.go b/build/build.go
@@ -21,6 +21,7 @@ import (
 
 var featureList = []string{
 	"go",
+	"zig",
 }
 
 ////////////////////////////////////////////////////////////
@@ -45,6 +46,7 @@ func init() {
 		return nil
 	})
 
+	////////// Go
 	gotaskr.Task("Feature:go:Package", func() error {
 		return packageFeature("go")
 	})
@@ -54,6 +56,17 @@ func init() {
 	gotaskr.Task("Feature:go:Publish", func() error {
 		return publishFeature("go")
 	})
+
+	////////// Zig
+	gotaskr.Task("Feature:zig:Package", func() error {
+		return packageFeature("zig")
+	})
+	gotaskr.Task("Feature:zig:Test", func() error {
+		return testFeature("zig")
+	})
+	gotaskr.Task("Feature:zig:Publish", func() error {
+		return publishFeature("zig")
+	})
 }
 
 ////////////////////////////////////////////////////////////
diff --git a/features/src/go/NOTES.md b/features/src/go/NOTES.md
@@ -3,3 +3,9 @@
 ### System Compatibility
 
 Debian, Ubuntu, Alpine
+
+### Accessed Urls
+
+Needs to access the following urls to install non-exact versions:
+* https://go.dev/dl/?mode=json&include=all
+* https://go.dev/VERSION?m=text
diff --git a/features/src/go/README.md b/features/src/go/README.md
@@ -35,3 +35,9 @@ A feature which installs Go.
 ### System Compatibility
 
 Debian, Ubuntu, Alpine
+
+### Accessed Urls
+
+Needs to access the following urls to install non-exact versions:
+* https://go.dev/dl/?mode=json&include=all
+* https://go.dev/VERSION?m=text
diff --git a/features/src/go/installer.go b/features/src/go/installer.go
@@ -96,7 +96,7 @@ func (c *goComponent) GetAllVersions() ([]*gover.Version, error) {
 	if err != nil {
 		return nil, err
 	}
-	var jsonData []map[string]interface{}
+	var jsonData []map[string]any
 	if err := json.Unmarshal(versionFileContent, &jsonData); err != nil {
 		return nil, err
 	}
diff --git a/features/src/zig/NOTES.md b/features/src/zig/NOTES.md
@@ -0,0 +1,10 @@
+## Notes
+
+### System Compatibility
+
+Debian, Ubuntu, Alpine
+
+### Accessed Urls
+
+Needs to access the following urls to install non-exact versions:
+* https://ziglang.org/download/index.json
diff --git a/features/src/zig/README.md b/features/src/zig/README.md
@@ -0,0 +1,36 @@
+# Zig (zig)
+
+A feature which installs Zig.
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/postfinance/devcontainer-features/zig:1.0.0": {
+        "version": "latest",
+        "isExactVersion": false,
+        "downloadRegistryBase": "",
+        "downloadRegistryPath": ""
+    }
+}
+```
+
+## Options
+
+| Option | Description | Type | Default Value | Proposals |
+|-----|-----|-----|-----|-----|
+| version | The version of Zig to install. | string | latest | latest, 0.13.0, 0.12 |
+| isExactVersion | Whether to install the exact version specified. | boolean | false | true, false |
+| downloadRegistryBase | The download registry to use for Zig binaries. | string | <empty> | https://mycompany.com/artifactory/ziglang-generic-remote |
+| downloadRegistryPath | The download registry path to use for Zig binaries. | string | <empty> |  |
+
+## Notes
+
+### System Compatibility
+
+Debian, Ubuntu, Alpine
+
+### Accessed Urls
+
+Needs to access the following urls to install non-exact versions:
+* https://ziglang.org/download/index.json
diff --git a/features/src/zig/devcontainer-feature.json b/features/src/zig/devcontainer-feature.json
@@ -0,0 +1,39 @@
+{
+    "id": "zig",
+    "version": "1.0.0",
+    "name": "Zig",
+    "description": "A feature which installs Zig.",
+    "options": {
+        "version": {
+            "type": "string",
+            "proposals": [
+                "latest",
+                "0.13.0",
+                "0.12"
+            ],
+            "default": "latest",
+            "description": "The version of Zig to install."
+        },
+        "isExactVersion": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether to install the exact version specified."
+        },
+        "downloadRegistryBase": {
+            "type": "string",
+            "default": "",
+            "proposals": [
+                "https://mycompany.com/artifactory/ziglang-generic-remote"
+            ],
+            "description": "The download registry to use for Zig binaries."
+        },
+        "downloadRegistryPath": {
+            "type": "string",
+            "default": "",
+            "description": "The download registry path to use for Zig binaries."
+        }
+    },
+    "containerEnv": {
+        "PATH": "/usr/local/zig:${PATH}"
+    }
+}
diff --git a/features/src/zig/install.sh b/features/src/zig/install.sh
@@ -0,0 +1,11 @@
+case $(uname -m) in
+  x86_64*) ARCH=amd64 ;;
+  arm*)    ARCH=arm64 ;;
+  *) echo "Unsupported architecture: $(uname -m)" >&2; exit 1 ;;
+esac
+
+"./installer_$ARCH" \
+    -version="${VERSION:-"latest"}" \
+    -isExactVersion="${IS_EXACT_VERSION:-false}" \
+    -downloadRegistryBase="${DOWNLOAD_REGISTRY_BASE:-""}" \
+    -downloadRegistryPath="${DOWNLOAD_REGISTRY_PATH:-""}"
diff --git a/features/src/zig/installer.go b/features/src/zig/installer.go
@@ -0,0 +1,140 @@
+package main
+
+import (
+	"builder/installer"
+	"encoding/json"
+	"flag"
+	"fmt"
+	"net/url"
+	"os"
+	"regexp"
+	"runtime"
+
+	"github.com/roemer/gover"
+)
+
+//////////
+// Configuration
+//////////
+
+const versionsIndexUrl = "https://ziglang.org/download/index.json"
+
+var versionRegexp *regexp.Regexp = gover.RegexpSimple
+
+//////////
+// Main
+//////////
+
+func main() {
+	if err := runMain(); err != nil {
+		fmt.Printf("Error: %v\n", err)
+		os.Exit(1)
+	}
+}
+
+func runMain() error {
+	// Handle the flags
+	version := flag.String("version", "latest", "The version of Zig to install.")
+	isExactVersion := flag.Bool("isExactVersion", false, "Whether to install the exact version specified.")
+	downloadRegistryBase := flag.String("downloadRegistryBase", "", "The download registry to use for Zig binaries.")
+	downloadRegistryPath := flag.String("downloadRegistryPath", "", "The download registry path to use for Zig binaries.")
+	flag.Parse()
+
+	// Load settings from an external file
+	if err := installer.LoadOverrides(); err != nil {
+		return err
+	}
+
+	installer.HandleOverride(downloadRegistryBase, "https://ziglang.org", "zig-download-registry-base")
+	installer.HandleOverride(downloadRegistryPath, "/download", "zig-download-registry-path")
+
+	// Create and process the feature
+	feature := installer.NewFeature("Zig", true,
+		&zigComponent{
+			ComponentBase:        installer.NewComponentBase("Zig", *version, *isExactVersion),
+			DownloadRegistryBase: *downloadRegistryBase,
+			DownloadRegistryPath: *downloadRegistryPath,
+		})
+	return feature.Process()
+}
+
+func buildUrl(base string, parts ...string) (string, error) {
+	return url.JoinPath(base, parts...)
+}
+
+//////////
+// Implementation
+//////////
+
+type zigComponent struct {
+	*installer.ComponentBase
+	DownloadRegistryBase string
+	DownloadRegistryPath string
+}
+
+func (c *zigComponent) GetAllVersions() ([]*gover.Version, error) {
+	versionFileContent, err := installer.Tools.Download.AsBytes(versionsIndexUrl)
+	if err != nil {
+		return nil, err
+	}
+	var jsonData map[string]any
+	if err := json.Unmarshal(versionFileContent, &jsonData); err != nil {
+		return nil, err
+	}
+	versions := []*gover.Version{}
+	for key := range jsonData {
+		if key == "master" {
+			continue
+		}
+		versionString := key
+		version, err := gover.ParseVersionFromRegex(versionString, versionRegexp)
+		if err != nil {
+			return nil, err
+		}
+		versions = append(versions, version)
+	}
+
+	return versions, nil
+}
+
+func (c *zigComponent) InstallVersion(version *gover.Version) error {
+	// Download the file
+	var fileName string
+	// The url format changed from OS-Arch-Version to Arch-OS-Version with 0.14.1
+	if version.LessThan(gover.ParseSimple(0, 14, 1)) {
+		switch runtime.GOARCH {
+		case "amd64":
+			fileName = fmt.Sprintf("zig-linux-x86_64-%s.tar.xz", version.Raw)
+		case "arm64":
+			fileName = fmt.Sprintf("zig-linux-aarch64-%s.tar.xz", version.Raw)
+		default:
+			return fmt.Errorf("unsupported architecture: %s", runtime.GOARCH)
+		}
+	} else {
+		switch runtime.GOARCH {
+		case "amd64":
+			fileName = fmt.Sprintf("zig-x86_64-linux-%s.tar.xz", version.Raw)
+		case "arm64":
+			fileName = fmt.Sprintf("zig-aarch64-linux-%s.tar.xz", version.Raw)
+		default:
+			return fmt.Errorf("unsupported architecture: %s", runtime.GOARCH)
+		}
+	}
+
+	downloadUrl, err := buildUrl(c.DownloadRegistryBase, c.DownloadRegistryPath, version.Raw, fileName)
+	if err != nil {
+		return err
+	}
+	if err := installer.Tools.Download.ToFile(downloadUrl, fileName, "zig"); err != nil {
+		return err
+	}
+	// Extract it
+	if err := installer.Tools.Compression.ExtractTarXz(fileName, "/usr/local/zig", true); err != nil {
+		return err
+	}
+	// Cleanup
+	if err := os.Remove(fileName); err != nil {
+		return err
+	}
+	return nil
+}
diff --git a/features/test/zig/install.sh b/features/test/zig/install.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+
+[[ -f "$(dirname "$0")/../functions.sh" ]] && source "$(dirname "$0")/../functions.sh"
+[[ -f "$(dirname "$0")/functions.sh" ]] && source "$(dirname "$0")/functions.sh"
+
+check_version "$(zig version)" "0.13.0"
diff --git a/features/test/zig/scenarios.json b/features/test/zig/scenarios.json
@@ -0,0 +1,15 @@
+{
+    "install": {
+        "build": {
+            "dockerfile": "Dockerfile",
+            "options": [
+                "--add-host=host.docker.internal:host-gateway"
+            ]
+        },
+        "features": {
+            "./zig": {
+                "version": "0.13.0"
+            }
+        }
+    }
+}
diff --git a/features/test/zig/test-images.json b/features/test/zig/test-images.json
@@ -0,0 +1,6 @@
+[
+    "mcr.microsoft.com/devcontainers/base:debian-11",
+    "mcr.microsoft.com/devcontainers/base:debian-12",
+    "mcr.microsoft.com/devcontainers/base:alpine",
+    "mcr.microsoft.com/devcontainers/base:ubuntu-24.04"
+]

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ func (c goComponent) GetAllVersions() ([]gover.Version, error) {`
`96`	`96`	`if err != nil {`
`97`	`97`	`return nil, err`
`98`	`98`	`}`
`99`		`- var jsonData []map[string]interface{}`
	`99`	`+ var jsonData []map[string]any`
`100`	`100`	`if err := json.Unmarshal(versionFileContent, &jsonData); err != nil {`
`101`	`101`	`return nil, err`
`102`	`102`	`}`