Skip to content

PACKAGING.md

Latest commit

 

History

History
97 lines (72 loc) · 4.28 KB

PACKAGING.md

File metadata and controls

97 lines (72 loc) · 4.28 KB
Raw

Packaging Teleprompter

The installer is a compressed .dmg containing Teleprompter.app, an Applications shortcut, short install instructions, and full license documents. The app inside is signed with Developer ID Application: Salty Panda LLC and notarized by Apple. The current public preview is version 1.2.2 (build 8), available from GitHub Releases. The Mac App Store is not a distribution channel for this release.

Install the app

Open the DMG, drag Teleprompter into Applications, eject the image, and open the installed app. It requires macOS 26 or later, Apple Silicon, and an open built-in MacBook display. Xcode isn't required to run it.

Speech models aren't bundled into the DMG. Apple Speech is the default, and the other three models can be downloaded inside the app. Updating the app preserves the draft and models in ~/Library/Application Support/Teleprompter/.

Build a signed installer

Run from the repository root:

./script/package_dmg.sh

The script archives the Release configuration, exports using Developer ID, submits the app for notarization, attaches Apple's ticket, and verifies the signature and Gatekeeper assessment before making the disk image. It also writes a SHA-256 checksum next to the DMG.

This uses the Apple account signed into Xcode and the Salty Panda team in script/ExportOptions.plist. Xcode can use the team's cloud-managed Developer ID certificate even when it doesn't appear in the local keychain's identity list. No private key or Apple password is stored in the repository.

Outputs:

  • dist/Teleprompter-<version>-arm64.dmg
  • dist/Teleprompter-<version>-arm64.dmg.sha256
  • Build, export, and notarization logs under build/packaging/

The filename and install instructions follow the exported bundle's version and build, set in App/Info.plist. The current source and installer are 1.2.2 (build 8). Each new installer must pass its own signing, notarization, and validation checks before upload. Generated installers, archives, models, and build logs are ignored by Git. Installers can be attached to this repository's GitHub releases. Keep preview releases marked as prereleases and include a link to the bug-report form.

To package an app that is already signed, notarized, and stapled:

./script/package_dmg.sh --app build/packaging/export/Teleprompter.app

The same validation gates run before packaging. A development-signed app or one without a valid notarization ticket won't pass.

License documents

Core/Licenses/ contains the full third-party texts and a manifest with source URLs, dependency revisions, and checksums. The app includes that folder, the project's LICENSE, and THIRD_PARTY_NOTICES.md as signed resources. The same documents are copied beside the app on the disk image.

Packaging checks dependency pins against the inventory and verifies every document in the exported app before creating the installer:

python3 script/verify_licenses.py
python3 script/verify_licenses.py --bundle build/packaging/export/Teleprompter.app

Update the inventory and license documents when changing dependency versions. Optional model downloads receive their own terms before downloading weights; models installed by earlier releases receive those documents when first used.

If notarization hasn't finished

Upload success alone doesn't mean approval. The script waits for the ticket and stops if it isn't available. Check the archive's status in Xcode Organizer, then attach and validate the ticket before trying the packaging-only command:

xcrun stapler staple build/packaging/export/Teleprompter.app
xcrun stapler validate build/packaging/export/Teleprompter.app
spctl --assess --type execute -vv build/packaging/export/Teleprompter.app

The Gatekeeper result should be accepted with source=Notarized Developer ID. See Apple's notarization documentation for signing requirements and failed-submission diagnostics.

The DMG wraps the notarized app; this process doesn't claim a separate signature or notarization ticket for the disk-image container itself.