DevOps & cloud
ci-bundle
Use when a decompilation or port whose tests need private data (the original program, game data, a commercial toolchain) should run its full gate and accuracy tests on free public GitHub runners - the encrypted bundle in a private repository, the deploy key and age key, the workflow templates, the safeguards that keep the data private, and key rotation.
abedegno · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add abedegno/Exhume --skill ci-bundleAbout this skill
name: ci-bundle description: Use when a decompilation or port whose tests need private data (the original program, game data, a commercial toolchain) should run its full gate and accuracy tests on free public GitHub runners - the encrypted bundle in a private repository, the deploy key and age key, the workflow templates, the safeguards that keep the data private, and key rotation.
CI with a private bundle
Paths are relative to the Exhume checkout. docs/ci-bundle.md is the pattern and the reasons; tools/templates/ci are the workflows; examples/uw2/ci.toml is UW2Decomp's instantiation, which reproduces its own CI byte for byte.
Steps
- The bundle. In an empty directory:
game/(the owner's own copy of the program),tc/andtasm/(the toolchain's disk images),MANIFEST.txt(what each is and where it came from). MakeSHA256SUMS, tar and encrypt with a new age key (docs/ci-bundle.md, "Making the bundle"). Keep the age secret key in the macOS Keychain (security add-generic-password -s PROJECT-ci-assets-age ...), nowhere else on disk. - The storage repository. A private repository holding only the encrypted file. Disable its Actions. Add a read-only deploy key (
ssh-keygen -t ed25519,gh repo deploy-key addwithout-w), and delete the local key files once the secret is set. - The secrets. In the public repository: the deploy key's private half and the age secret key (
gh secret set). Nothing else needs a secret. - The workflows. Fill in a values file (start from
python3 tools/citemplates.py --listand tools/templates/ci/defaults.toml) and point[ci] varsat it;python3 tools/citemplates.py --config exhume.toml .writes.github/workflows/{accuracy,nightly,port,repocheck}.ymland the two actions. Runactionlinton them. - Prove it before trusting it. Push to a branch of the repository itself and watch accuracy.yml run the fast tier; run nightly.yml by hand once. Read the artifacts list of a failing run: only pictures and logs.
- Rotate on any suspicion, and when a collaborator leaves: a new deploy key, a new age key, a new bundle (docs/ci-bundle.md, "Rotation").
Rules
- Never
pull_request_target; a fork's pull request gets the data-free workflows only. - Never cache anything decrypted or built from it; cache only the tools, keyed by the script that pins each.
- Upload only pictures and text logs, never dumps, saves, objects or EXEs.
- Never list or print the decrypted tree; ci-assets.sh prints a count.
- The last step of every job with the bundle deletes the decrypted tree, the clone, the key file, the toolchain and
build/, underif: always(). permissions: contents: readeverywhere;persist-credentials: falseon checkouts.- On Linux, find DOS outputs without regard to case, and unpack everything the link needs from the disk images (Turbo C++'s OVERLAY.LIB is in XLIB.ZIP).