Skip to content

chore: move the example ssab deploy script to scripts/deploy-examples - #247

Merged
Naruto merged 1 commit into
developfrom
chore/move-deploy-examples-script
Aug 1, 2026
Merged

Naruto merged 1 commit into
developfrom
chore/move-deploy-examples-script

Conversation

@Naruto

@Naruto Naruto commented Aug 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

examples/update_ssabs.{sh,ps1} was the only maintainer script living outside scripts/, and the only one using snake_case. The sibling players (Flutter / RenPy / Web / Wgpu) all expose this as scripts/deploy-examples.{sh,ps1}, so this moves it there with git mv. Nothing referenced the old path (README / docs / CI / CONTRIBUTING all had zero hits), so the move is a pure rename.

Changes

  • Move: examples/update_ssabs.{sh,ps1}scripts/deploy-examples.{sh,ps1}, path resolution switched to the BASEDIR / ROOTDIR pattern the other scripts use.
  • Fail fast: set -euo pipefail on the shell side; $ErrorActionPreference = "Stop" plus explicit $LASTEXITCODE checks on the PowerShell side, which previously kept going after a failed cargo build (native commands do not honour Stop on their own).
  • Preflight: report an uninitialized SDK submodule (with the git submodule update --init --recursive hint), a missing cargo, and a missing source .sspj, instead of failing somewhere inside the build.
  • Simplify: the per-project if branches are replaced by a flat "<SDK tests subdir>|<examples subdir>" deployment table — same five destinations as before (overall, overall_gdextension, Ringo, Override_Ringo, Scripting).
  • Document: new section under For SpriteStudio-SDK Developers in docs/en/setup/build.md and docs/ja/setup/build.md, plus a row in the AGENTS.md verification table. The script header now also records why examples/dev_* is excluded and how this relates to the editor's .ssplayer_sources.cfg source sync.

No behavioural change to the generated output, and .gitignore is untouched — examples/dev_*/ssab_generated stays the only ignored one, since released sample projects do ship their .ssab.

Verification

  • ./scripts/deploy-examples.sh run end to end: all five destinations converted successfully with ssconverter-cli 7.0.0-beta.1.
  • scripts/deploy-examples.ps1 parsed with the PowerShell parser (it targets ssconverter-cli.exe, so it cannot be executed on macOS).

The Evernote release procedure has been updated to the new path separately.

Renames examples/update_ssabs.{sh,ps1} to scripts/deploy-examples.{sh,ps1},
matching the sibling players and this repository's own kebab-case scripts/
layout. Nothing referenced the old path.

- Fail fast: set -euo pipefail on the shell side, $ErrorActionPreference and
  $LASTEXITCODE checks on the PowerShell side (native commands do not stop on
  their own).
- Preflight the SDK submodule, cargo and the source .sspj with actionable
  messages instead of failing deep inside cargo.
- Replace the per-project if branches with a flat deployment table.
- Document it under "For SpriteStudio-SDK Developers" (en/ja) and add a row to
  the AGENTS.md verification table.
@Naruto
Naruto merged commit 466ba21 into develop Aug 1, 2026
2 of 4 checks passed
@Naruto
Naruto deleted the chore/move-deploy-examples-script branch August 1, 2026 04:03
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.

1 participant