Skip to content

Watch the engine's pinned third-party sources - #43

Merged
chrislaupama merged 5 commits into
mainfrom
engine-pins
Nov 12, 2026
Merged

chrislaupama merged 5 commits into
mainfrom
engine-pins

Conversation

@chrislaupama

@chrislaupama chrislaupama commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

What

Closes #39. The engine's FetchContent pins are invisible to Dependabot and cargo audit; this makes them checked.

  • Build-time verification. engine/CMakeLists.txt records the commit behind every pinned tag (DSTUDIO_<NAME>_TAG_COMMIT). After fetching, the configure step compares each checkout's HEAD with its pin and stops if they differ, so a tag moved upstream cannot change what gets built. Skipped for FETCHCONTENT_SOURCE_DIR_<NAME> overrides.
  • tools/ci/engine_pins.py. Reads the pins from engine/CMakeLists.txt and compares each with upstream using only git: a newer release tag, a moved or deleted tag, and for the commit pins (dr_libs, stb) a change upstream to one of the files we compile. Prints a Markdown report; --self-test checks the parser and comparison offline and runs in lint.
  • Engine pins workflow. Every Monday it runs the script and keeps one issue, "Engine third-party pins need attention", open and current while something is behind, and closes it when all pins are current.
  • Docs. docs/building.md has a new "Engine dependencies" section with the update steps.

Today's report from the script:

Pin Pinned Upstream Status
DSTUDIO_CLAP_TAG 1.2.10 1.2.10 current
DSTUDIO_VST3SDK_TAG v3.8.1_build_84 v3.8.1_build_84 current
DSTUDIO_STRETCH_TAG 1.4.0 1.4.0 current
DSTUDIO_LINEAR_TAG 0.6.4 0.6.6 behind: 0.6.6
DSTUDIO_DR_LIBS_COMMIT 35b5c392cc15 f12e197fd462 behind: dr_flac.h, dr_mp3.h, dr_wav.h
DSTUDIO_STB_COMMIT 4e9b368bfc07 965c80bc0b13 behind: stb_vorbis.c

The updates themselves are left for a separate change (the workflow's first run will open the issue for them).

Checked locally: a correct pin configures; a deliberately wrong DSTUDIO_CLAP_TAG_COMMIT stops the configure step with the expected message.

Screenshots

No visual change.

Benchmarks

No runtime code changes. The configure step gains six git rev-parse calls.

Docs

  • README.md is still accurate
  • docs/building.md updated

Generated by Claude Code

The hosted Linux runner moved to Ubuntu 26.04, whose GCC 15 reports
-Wnull-dereference (an error in CI) in three files:

- Copies of file-scope default vectors written through operator[]: GCC
  can't see that a dynamically initialised global is non-empty. Use .at()
  for those writes in test_mod_routes.cpp and bench_devices.cpp.
- memcpy from an empty vector's data() in bench_devices.cpp: skip the
  copy when there is nothing to copy (memcpy from null is undefined even
  for zero bytes).
- sorted.back() on a possibly empty timing vector in bench_render.cpp:
  guard it the way run_render already does.
- engine/CMakeLists.txt records the commit behind every pinned tag and the
  configure step fails if a fetched checkout is at a different commit.
- tools/ci/engine_pins.py compares each pin with upstream (newer release
  tag, moved tag, or a change to a decoder file we compile).
- The weekly Engine pins workflow keeps one issue open while something is
  behind and closes it when all pins are current.
- docs/building.md describes how engine dependencies are updated.
@chrislaupama chrislaupama self-assigned this Nov 12, 2026
@chrislaupama
chrislaupama marked this pull request as ready for review November 12, 2026 03:53
@chrislaupama
chrislaupama merged commit 450a388 into main Nov 12, 2026
16 checks passed
@chrislaupama
chrislaupama deleted the engine-pins branch November 12, 2026 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Track the engine's pinned third-party sources for updates and advisories

1 participant