Skip to content

building a release

Joe Steccato edited this page Sep 8, 2025 · 4 revisions

instructions for ppooll maintainers on how to create a version release

developer setup

this is needed for codesigning the externals (.mxo)

git clone --recurse-submodules https://github.com/ppooll-dev/ppooll.git
cd ppooll
cp .env.template .env
# Edit .env to set your Developer ID and Notarization Profile

bumping version

Update the package-info.json with a new version number:

./scripts/bump_version.sh 1.0.0

This only updates package-info.json (it does not commit yet).


building and signing a new release

./scripts/build_package.sh

This will:

  • Copy and assemble the ppooll package structure
  • Sign all .mxo externals inside /externals/
  • Zip the entire package as ppooll.zip
  • Submit for notarization
  • Staple the notarization ticket

commit changes

Commit the package-info.json and git tag with the new version number.


🏷 publishing a GitHub release

  1. Go to Releases page
  2. Click Draft a new release
  3. Set:
    • Tag name: v1.0.0
    • Release title: ppooll v1.0.0
  4. Upload ppooll.zip as a release asset
  5. Publish

🧹 cleaning build artifacts

After publishing a release:

./scripts/clean.sh

This removes:

  • package/
  • ppooll.zip

⚡ important notes

  • .mxe64 (Windows externals) are NOT signed — only .mxo files
  • ppooll.zip must always include package-info.json, README.md, LICENSE.md, and CHANGELOG.md
  • macOS notarization ensures smoother installation on newer systems

Clone this wiki locally