chore: move the example ssab deploy script to scripts/deploy-examples - #247
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
examples/update_ssabs.{sh,ps1}was the only maintainer script living outsidescripts/, and the only one using snake_case. The sibling players (Flutter / RenPy / Web / Wgpu) all expose this asscripts/deploy-examples.{sh,ps1}, so this moves it there withgit mv. Nothing referenced the old path (README / docs / CI / CONTRIBUTING all had zero hits), so the move is a pure rename.Changes
examples/update_ssabs.{sh,ps1}→scripts/deploy-examples.{sh,ps1}, path resolution switched to theBASEDIR/ROOTDIRpattern the other scripts use.set -euo pipefailon the shell side;$ErrorActionPreference = "Stop"plus explicit$LASTEXITCODEchecks on the PowerShell side, which previously kept going after a failedcargo build(native commands do not honourStopon their own).git submodule update --init --recursivehint), a missingcargo, and a missing source.sspj, instead of failing somewhere inside the build.ifbranches are replaced by a flat"<SDK tests subdir>|<examples subdir>"deployment table — same five destinations as before (overall,overall_gdextension,Ringo,Override_Ringo,Scripting).docs/en/setup/build.mdanddocs/ja/setup/build.md, plus a row in theAGENTS.mdverification table. The script header now also records whyexamples/dev_*is excluded and how this relates to the editor's.ssplayer_sources.cfgsource sync.No behavioural change to the generated output, and
.gitignoreis untouched —examples/dev_*/ssab_generatedstays the only ignored one, since released sample projects do ship their.ssab.Verification
./scripts/deploy-examples.shrun end to end: all five destinations converted successfully with ssconverter-cli 7.0.0-beta.1.scripts/deploy-examples.ps1parsed with the PowerShell parser (it targetsssconverter-cli.exe, so it cannot be executed on macOS).The Evernote release procedure has been updated to the new path separately.