From 9183dacc4c308b1d3ea810b5e5e1b5a870af577b Mon Sep 17 00:00:00 2001 From: Eli Adelhult Date: Fri, 22 May 2026 10:28:48 +0200 Subject: [PATCH 1/2] Add note about versioning policy --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec8db12..0b1135c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,21 @@ pnpm build pnpm link ``` +## Versioning policy + +GM-CLI uses [semantic versioning](https://semver.org), i.e. `MAJOR.MINOR.PATCH`. The public API surface consists of, + +- Command-line arguments for the program, including their implicit defaults. +- The schema for the `gm-options.json` file. +- The internal structure of the `.gmcache` directory (and the minimum version requirement for external tools like Igor and ProjectTool). + +A breaking change to any of these warents increasing the `MAJOR` version of the package. When this occurs GM-CLI will +automatically pruge any outdated caches and update the path in the `$schema` field in `gm-options.json`. + +In some scenarios we make use of this cache purging mechanism to make sure users have access to more recent versions +of external tools that GM-CLI depends on. For instance, if we require a new version of Igor for GM-CLI to function, we may bump the +major version. + ## Publish ```sh From 781dd5736a62b5648fe0f68d726423ed0268932e Mon Sep 17 00:00:00 2001 From: Eli Adelhult Date: Fri, 22 May 2026 10:32:33 +0200 Subject: [PATCH 2/2] 2.0.0 --- CHANGELOG.md | 4 ++++ package.json | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c09474a..cc20b1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# 2.0.0 + +- Breaking: a new release of Igor is required to support LTS 2026, a major version release purges all outdated GM-CLI caches. + # 1.4.1 - Fix: Relative project paths are now handled correctly (e.g. `gm-cli run ./some/project.yyp` works as intended) diff --git a/package.json b/package.json index 66b320e..6beb685 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "url": "https://github.com/YoYoGames/gm-cli" }, "type": "module", - "version": "1.4.1", + "version": "2.0.0", "files": [ "dist", "NOTICE"