Skip to main content

1.0 Release Checklist

1.0.x is the SaveFlow Lite stable line.

Use this checklist before publishing any 1.0.x build.

Release Scope​

Allowed:

  • bug fixes
  • test coverage
  • packaging validation
  • install and upgrade validation
  • documentation consistency fixes
  • wording fixes for diagnostics, setup health, and reference pages

Avoid:

  • new broad public APIs
  • Pro orchestration features
  • migration registry or save upgrade pipeline
  • cloud sync
  • background save pipeline
  • reference repair systems

Install And Upgrade Matrix​

Validate these paths:

PathExpected result
Fresh addons zip installaddons/saveflow_core and addons/saveflow_lite copy cleanly into an empty project.
Fresh Godot Asset Library style installArchive root contains only addons/.
Demo zip openDemo project opens with addons/, demo/saveflow_lite, project.godot, and README.
Existing 0.9.4 project overwriteReplacing the addon folders keeps the SaveFlow autoload and project settings usable.
Docs-site/repository cloneRepository-only paths stay outside install guidance and release addon zips.

Local Verification​

Run:

.\tools\import_project.ps1
.\tools\run_gdunit.ps1 -ContinueOnFailure
.\tools\release\validate_saveflow_lite_upgrade.ps1
.\tools\release\validate_saveflow_lite_mono_clean_install.ps1 -ZipPath <addons-zip>

Build the docs site:

cd docs-site
npm run build

Release Asset Verification​

publish_saveflow_lite.ps1 must verify:

  • plugin.cfg, addons/saveflow_core/version.txt, README, and changelog version consistency
  • addons-only zip allowed roots
  • demo zip allowed roots
  • forbidden repository roots are absent from release zips
  • Asset Library archive exports only addons/
  • SHA-256 checksum manifest exists for the zip assets
  • clean install validation passes for the generated addons-only zip
  • 0.9.4-to-current upgrade validation passes for the generated addons-only zip
  • Mono clean install validation passes for the generated addons-only zip
  • published release validation passes after GitHub release upload

The clean install validation expands the addons zip into a temporary Godot project, enables SaveFlow Lite, confirms the SaveFlow autoload persists, runs a runtime smoke script, and runs Godot --check-only.

The upgrade validation expands the 0.9.4 addons zip into a temporary Godot project, enables SaveFlow Lite, overwrites the addon folders with the current addons zip, confirms the SaveFlow autoload and project settings persist, runs a runtime smoke script, and runs Godot --check-only.

The checksum manifest is uploaded as saveflow-lite-v{version}-SHA256SUMS.txt and includes one SHA-256 entry for the addons zip and one for the addons-demo zip.

The Mono clean install validation expands the addons zip into a temporary Godot C# project, enables SaveFlow Lite, builds a minimal SaveFlowClient smoke project, runs the smoke scene, and runs Godot --check-only.

The published release validation downloads the GitHub Release assets for the tag, verifies the checksum manifest against the downloaded zip files, checks the release zip shape again, and reruns clean install plus Mono clean install against the downloaded addons zip.

After release upload, the same published release validation can be rerun with:

.\tools\release\validate_saveflow_lite_published_release.ps1 -Version <version>

Release Notes​

For 1.0.x, release notes should emphasize:

  • stable baseline polish
  • fixed regressions
  • install/package validation
  • docs/API consistency

Do not introduce broad new public APIs in a 1.0.x patch release unless the compatibility tradeoff is clearly smaller than shipping the mistake.