mach/.github/ISSUE_TEMPLATE/dev_zig_nomination.md

name	about	title	labels	assignees
(dev) Zig version update	The process we follow to perform a Zig version update	all: nominate Zig YYYY.MM.0-mach	all, zig-update	slimsag

Periodically we nominate a new Zig nightly version to be the version that Mach targets, and begin the meticulous process of updating every Mach project to use that new version.

This is the tracking issue to do that for the next scheduled nomination (see the date in the issue title.)

You may have been linked to this issue because you sent a pull request to update a Mach project to use a new Zig API - if that is the case we do appreciate the PR and will look at merging it once this process begins. In the meantime, your PR may stay open for a while. You can either use a fork of the project, or use the version of Zig that Mach currently supports.

Update process

• It is time to begin (see date in issue title, we aim to begin this checklist between the 1st-4th of that month.)
• In machengine.org repository static/zig folder, wrench script nominate-zig-index-update nominate 2024.1.0-mach-wip has been ran and the index.json has been updated.
• #wrench automation (!wrench script-all rebuild then !wrench schedule-now update-zig-version) has created new pull requests to update the Zig version used in CI of all our projects, and it matches index.json.
• The Nomination history has a new section for the latest nightly Zig version which Wrench used in its PRs, with a warning at the top **IN-PROGRESS:** This version is currently being nominated, see [the tracking issue](https://github.com/hexops/mach/issues/1135) for details. Once everything looks good, the new Zig version is confirmed to be working with Mach, we will declare success, close the issue, and remove this in-progress warning..
• #general Discord message: Beginning the process of nominating a new Zig version! (you should wait to upgrade until we've updated everything to confirm it works) $GITHUB_ISSUE
• "First-order projects" below (which have zero build.zig.zon dependencies) have been updated, their CI is passing/green using the new version.
• "Second-order projects" below (which have build.zig.zon dependencies) have been updated, their CI is passing/green using the new version.
• The .zigversion file https://github.com/hexops/mach/blob/main/.zigversion has been updated.
• The mach build.zig version check has been updated: https://github.com/hexops/mach/blob/main/build.zig#L187-L192
• The mach-core build.zig version check has been updated: https://github.com/hexops/mach-core/blob/main/build.zig#L222-L227
• The mach-glfw build.zig version check has been updated: https://github.com/hexops/mach-glfw/blob/main/build.zig
• https://machengine.org/about/zig-version has been updated
• In machengine.org repository static/zig folder, wrench script nominate-zig-index-update finalize 2024.1.0-mach-wip has been ran and the index.json has had -wip removed and the mach-latest entry has been updated.
• The **IN-PROGRESS** warning in the Nomination history has been removed.
• A new issue has been filed for the next nomination.
• A #progress announcement has been made:

We've just finished updating to the new nominated Zig version 2024.01 (0.12.0-dev.2059+42389cb9c). We encourage you to update your projects to that Zig version now. :) $GITHUB_ISSUE

First-order projects

These projects have zero build.zig.zon dependencies, we update them first - and in any order.

• mach-ecs
• mach-gamemode
• mach-model3d
• mach-sysjs
• mach-objc-generator
• fastfilter
• spirv-cross
• brotli
• wayland-headers
• x11-headers
• vulkan-headers
• opengl-headers
• linux-audio-headers
• xcode-frameworks
• basisu
• vulkan-zig-generated
• directx-headers
• direct3d-headers
• opus
• flac
• ogg
• mach-core-example-assets
• font-assets

Second-order projects

Second-order projects

These projects have dependencies on other projects. We update them in the exact order below, top-to-bottom.

• spirv-tools, which depends on:
  • External package https://github.com/KhronosGroup/SPIRV-Headers
• freetype, which depends on:
  • brotli
• opusfile, which depends on:
  • opus
  • ogg
• harfbuzz, which depends on:
  • freetype
  • brotli
• glfw, which depends on:
  • xcode-frameworks
  • vulkan-headers
  • wayland-headers
  • x11-headers
• mach-basisu, which depends on:
  • basisu
• mach-objc, which depends on:
  • xcode-frameworks
• mach-flac, which depends on:
  • flac
  • mach-sysaudio
  • linux-audio-headers
• mach-sysaudio, which depends on:
  • mach-sysjs
  • linux-audio-headers
  • xcode-frameworks
• mach-opus, which depends on:
  • opusfile
  • mach-sysaudio
  • linux-audio-headers
• mach-dxcompiler, which depends on:
  • directx-headers
• mach-glfw, which depends on:
  • glfw
• mach-freetype, which depends on:
  • freetype
  • harfbuzz
  • font-assets
• mach-gpu-dawn, which depends on:
  • xcode-frameworks
  • direct3d-headers
  • vulkan-headers
  • x11-headers
• mach-gpu, which depends on:
  • mach-glfw
  • mach-gpu-dawn
• mach-sysgpu, which depends on:
  • vulkan-zig-generated
  • mach-gpu
  • mach-objc
  • direct3d-headers
  • opengl-headers
  • xcode-frameworks
• mach-core, which depends on:
  • build.zig version check
  • mach-core-example-assets
  • mach-gamemode
  • mach-sysgpu
  • mach-gpu
  • mach-glfw
• mach-core-starter-project, which depends on:
  • mach-core
• mach, which depends on:
  • .zigversion
  • build.zig version check
  • mach-ecs
  • mach-core
  • mach-basisu
  • mach-sysaudio
  • mach-freetype
  • mach-sysjs
  • font-assets
• mach-examples, which depends on:
  • zigimg
  • mach
  • mach-freetype
• mach-editor, which depends on:
  • mach
  • mach-sysgpu
  • spirv-cross
  • spirv-tools