Skip to content

armgit / nota

Public Imported from GitHub
0

Nota — a free DAW for macOS, Windows and Linux. No subscription, no account — just open it and make music.

Add engine versioning

Egor Khindikaynen41841dd83ba8
diff --git a/.claude/skills/release/SKILL.md b/.claude/skills/release/SKILL.md
index f158637a..cc759a3b 100644
--- a/.claude/skills/release/SKILL.md
+++ b/.claude/skills/release/SKILL.md
@@ -1,13 +1,14 @@
---
name: release
-description: Cut a Nota release — actualize CHANGELOG.md (promote [Unreleased] to a dated version and add a short human-readable summary of it), bump VERSION, create the vX.Y.Z tag, then commit and push. Run this when the user asks to release, ship, cut a version, or tag a release. The GitHub Actions release workflow then builds every platform and drafts the release from the changelog section.
+description: Cut a Nota release — actualize CHANGELOG.md (promote [Unreleased] to a dated version and add a short human-readable summary of it), bump VERSION and the engine's src/native/nota.engine/VERSION, create the vX.Y.Z tag, then commit and push. Run this when the user asks to release, ship, cut a version, or tag a release. The GitHub Actions release workflow then builds every platform and drafts the release from the changelog section.
user-invocable: true
---
# Cutting a Nota release
A release is a deliberate act: `## [Unreleased]` in `CHANGELOG.md` is promoted to a dated
-version, `VERSION` is bumped, a `vX.Y.Z` tag is created, and pushing the tag triggers
+version, `VERSION` is bumped (and the native engine's own
+`src/native/nota.engine/VERSION`), a `vX.Y.Z` tag is created, and pushing the tag triggers
`.github/workflows/release.yml` — which builds every target (x64 + arm64 across macOS,
Windows, Linux) and drafts the GitHub release using the version's changelog section as the
body.
@@ -25,7 +26,7 @@ or an explicit `X.Y.Z`. Nota has historically bumped **minor** per release.
1. **On `main`.** `git rev-parse --abbrev-ref HEAD` must be `main`. Releases build only
from main (the CI guard enforces it too). If not, stop and tell the user.
2. **Clean working tree.** `git status --porcelain` must be empty, so the release commit
- contains *only* the VERSION + CHANGELOG changes. If dirty, stop and ask the user to
+ contains *only* the VERSION + engine VERSION + CHANGELOG changes. If dirty, stop and ask the user to
commit or stash first.
3. **Up to date with origin.** `git fetch origin` then confirm local `main` is not behind
`origin/main` (`git rev-list --left-right --count origin/main...HEAD`). If behind, stop.
@@ -84,10 +85,28 @@ Write the new `X.Y.Z` to `VERSION` (no trailing newline changes beyond what's al
there; it's read with `.Trim()`). This is the single source of truth the CI checks the tag
against — it MUST equal the tag version.
+## 3b. Bump the engine version
+
+The native engine (`src/native/nota.engine`) has its own semver in
+`src/native/nota.engine/VERSION`, independent of the app version. CMake reads it into
+`project(... VERSION)` and bakes it into `nota_engine_version()` (shown in the About
+window next to the app version). It moves only when the engine itself changed:
+
+- Find the previous release tag: `git describe --tags --abbrev=0 --match 'v*'`.
+- Check for engine changes since then:
+ `git diff --quiet <prev-tag> HEAD -- src/native/nota.engine` (exit 1 = changed).
+- **Changed** → bump the engine's **patch** (`a.b.c` → `a.b.(c+1)`). If the user asked
+ for an explicit engine bump (e.g. "engine minor", or an explicit engine `X.Y.Z`), use
+ that instead — minor for a C ABI change (new/changed `nota_*` exports), major for a
+ breaking one.
+- **Unchanged** → leave it as-is.
+
+Tell the user the old → new engine version (or that it's unchanged).
+
## 4. Commit, tag, push
```bash
-git add VERSION CHANGELOG.md
+git add VERSION CHANGELOG.md src/native/nota.engine/VERSION
git commit -m "Release vX.Y.Z"
git tag -a "vX.Y.Z" -m "Nota vX.Y.Z"
git push origin main
@@ -106,6 +125,7 @@ Notes:
Tell the user:
- the released version and tag,
+- the engine version (bumped `a.b.c → a.b.d`, or unchanged),
- the Highlights you wrote,
- that the tag push kicked off `.github/workflows/release.yml`, which will produce the 5
platform artifacts and a **draft** GitHub release (they review + publish manually),
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 07ae2cce..e37f02e6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,6 +18,10 @@ Entry categories: `Added`, `Changed`, `Fixed`, `Removed`.
## [Unreleased]
+### Changed
+- The audio engine now has its own version (starting at 0.2.5, shown in About) instead of a
+ fixed 0.1.0; it's bumped with each release that changes the engine.
+
## [0.41.0] — 2026-09-24
### Highlights
diff --git a/src/managed/Nota.Infrastructure/Interop/NotaEngine.cs b/src/managed/Nota.Infrastructure/Interop/NotaEngine.cs
index fdbc96ed..3ba2c164 100644
--- a/src/managed/Nota.Infrastructure/Interop/NotaEngine.cs
+++ b/src/managed/Nota.Infrastructure/Interop/NotaEngine.cs
@@ -23,7 +23,7 @@ public sealed partial class NotaEngine : IAudioEngine
throw new InvalidOperationException("Failed to create native engine.");
}
- /// <summary>Engine library version, e.g. "0.1.0".</summary>
+ /// <summary>Engine library version, e.g. "0.2.5" (src/native/nota.engine/VERSION).</summary>
public static string Version => Marshal.PtrToStringUTF8(NativeMethods.Version()) ?? "?";
/// <summary>Negotiated output sample rate, or 0 if not started.</summary>
diff --git a/src/native/nota.engine/CMakeLists.txt b/src/native/nota.engine/CMakeLists.txt
index c3057fda..9b836f60 100644
--- a/src/native/nota.engine/CMakeLists.txt
+++ b/src/native/nota.engine/CMakeLists.txt
@@ -1,9 +1,15 @@
# SPDX-License-Identifier: AGPL-3.0-only
cmake_minimum_required(VERSION 3.24)
+# Engine version: single source of truth is the VERSION file next to this one,
+# bumped by the release skill (independent of the app's repo-root VERSION).
+file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" NOTA_ENGINE_VERSION LIMIT_COUNT 1)
+string(STRIP "${NOTA_ENGINE_VERSION}" NOTA_ENGINE_VERSION)
+set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/VERSION")
+
# OBJC/OBJCXX only exist on Apple; enable them conditionally so the Windows
# (MSVC/clang-cl) configure doesn't fail looking for an Objective-C compiler.
-project(nota_engine LANGUAGES C CXX VERSION 0.1.0)
+project(nota_engine LANGUAGES C CXX VERSION ${NOTA_ENGINE_VERSION})
if(APPLE)
enable_language(OBJC)
enable_language(OBJCXX)
@@ -96,6 +102,9 @@ target_include_directories(nota_engine
PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/vendor # Signalsmith Stretch, miniaudio, RtMidi
)
+target_compile_definitions(nota_engine PRIVATE
+ NOTA_VERSION_STRING="${PROJECT_VERSION}")
+
# Output a stable name: libnota_engine.dylib / nota_engine.dll (consumed by P/Invoke).
set_target_properties(nota_engine PROPERTIES
OUTPUT_NAME "nota_engine"
diff --git a/src/native/nota.engine/VERSION b/src/native/nota.engine/VERSION
new file mode 100644
index 00000000..3a4036fb
--- /dev/null
+++ b/src/native/nota.engine/VERSION
@@ -0,0 +1 @@
+0.2.5
diff --git a/src/native/nota.engine/include/nota/nota_engine.h b/src/native/nota.engine/include/nota/nota_engine.h
index 3e87d8bb..e3cca90a 100644
--- a/src/native/nota.engine/include/nota/nota_engine.h
+++ b/src/native/nota.engine/include/nota/nota_engine.h
@@ -128,7 +128,7 @@ typedef struct NotaMeter {
float rms_r;
} NotaMeter;
-/* Library version string, e.g. "0.1.0" (M0). Never NULL. */
+/* Library version string, e.g. "0.2.5" (from nota.engine/VERSION). Never NULL. */
NOTA_API const char* nota_engine_version(void);
/* Create / destroy the engine. create() returns NULL on failure. */
diff --git a/src/native/nota.engine/src/nota_engine_core.cpp b/src/native/nota.engine/src/nota_engine_core.cpp
index 6a9c12ad..8bb7f642 100644
--- a/src/native/nota.engine/src/nota_engine_core.cpp
+++ b/src/native/nota.engine/src/nota_engine_core.cpp
@@ -12,7 +12,10 @@
#include <new>
#include <string>
-#define NOTA_VERSION_STRING "0.1.0"
+// Injected by CMake from src/native/nota.engine/VERSION.
+#ifndef NOTA_VERSION_STRING
+#error "NOTA_VERSION_STRING must be defined by the build (see CMakeLists.txt)"
+#endif
extern "C" {