Skip to content

release.md

Latest commit

 

History

History
157 lines (118 loc) · 6.69 KB

release.md

File metadata and controls

157 lines (118 loc) · 6.69 KB
Raw

Release Guide

OpenStream releases should give users direct installable assets instead of making them use GitHub source-code archives.

Release Assets

Asset Audience Purpose
openstream-android.apk Android users Signed install package for the OpenStream camera app.
openstream-android.apk.sha256 Android users and automation SHA-256 checksum for the exact APK in the release.
openstream-android-update.json Android app updater Version metadata used by the in-app update prompt.
openstream-obs-plugin-installer-windows-x64.exe Windows OBS users Recommended one-click OBS plugin installer.
openstream-obs-plugin-installer-windows-x64.exe.sha256 Users and updater SHA-256 checksum for the exact OBS installer.
openstream-obs-update.json OBS plugin updater Version, installer asset, size, digest, and release URL.
openstream-obs-windows-x64.zip Technical users Manual plugin package with DLL and install scripts.

Automated Release

Create and push a version tag. For example, the current V2 beta release uses v2.1.0-beta:

git tag -a v2.1.0-beta -m "OpenStream v2.1.0-beta"
git push origin v2.1.0-beta

The Release workflow builds:

Job Output
Android APK openstream-android.apk, openstream-android-update.json
OBS plugin package openstream-obs-windows-x64.zip
OBS plugin installer openstream-obs-plugin-installer-windows-x64.exe

The publish job runs only after the repository tests, Android unit tests and lint, signed Android build, and OBS plugin build succeed. It downloads the artifacts, normalizes the APK name, writes its SHA-256 checksum into both a sidecar file and the Android update metadata, and runs gh release create.

You can also run the Release workflow manually from GitHub Actions and provide a tag such as v2.1.0-beta.

The Android job passes the release tag into Gradle as the APK versionName and uses the release commit timestamp as versionCode, so update ordering stays monotonic across full releases.

The OBS job embeds the same release version into the plugin and installer. The publish job computes the final installer digest and size, then emits openstream-obs-update.json. The plugin must never replace its loaded DLL; updates are handed to the installer after OBS has closed.

Public releases require all Android signing secrets. Missing or incomplete signing inputs fail the workflow; it never publishes a debug-signed fallback. Debug APKs remain available only as pull-request and local development artifacts.

In-App Updates

The Android APK workflow runs pytest, Android unit tests, lint, and a debug streaming build for pull requests and pushes. It publishes CI artifacts only.

In-app updates follow GitHub's latest full release. The APK, checksum metadata, Windows OBS installer, and plugin zip therefore come from the same commit. The app verifies the APK SHA-256 digest before opening the package installer.

OBS updates follow the same atomic release. The recommended installer uses the canonical OBS installation directory, removes known stale per-user and ProgramData copies, and is registered with Windows, so running a newer installer performs an upgrade and Windows Settings can uninstall it. Close OBS before install or update. The zip fallback remains a no-elevation per-user installation for technical users who do not have legacy system copies.

The OBS dock performs a short passive check of the latest update manifest. If the version differs, it shows a link to the immutable GitHub release page. It does not download or execute code and it never modifies the loaded plugin DLL. The installer digest remains available for users and future verified-download automation.

Android and OBS compatibility gate

Changes to discovery, pairing, required control tokens, reservation behavior, or media framing must ship atomically in a full release containing both the Android APK and OBS artifacts.

For example, an Android build that introduces a required control token cannot pair with an older OBS plugin whose beacon does not contain that token. Tests and review must cover the old/new compatibility matrix before changing either side of the wire contract.

Android Signing Secrets

Configure all of these GitHub Actions secrets before publishing an Android update or full release:

Secret Purpose
OPENSTREAM_RELEASE_KEYSTORE_BASE64 Base64-encoded Android keystore file.
OPENSTREAM_RELEASE_STORE_PASSWORD Keystore password.
OPENSTREAM_RELEASE_KEY_ALIAS Release key alias.
OPENSTREAM_RELEASE_KEY_PASSWORD Release key password.

Local Plugin Packaging

Build and package the OBS plugin without installing it locally:

$env:OPENSTREAM_SKIP_INSTALL = "1"
$env:OPENSTREAM_PLUGIN_PACKAGE_DIR = "$PWD\artifacts"
.\build_plugin.bat

Output:

artifacts/openstream-obs-windows-x64.zip

The zip contains:

openstream-obs.dll
Install-OpenStreamPlugin.ps1
install-openstream-plugin.bat

To use an OBS install outside C:\Program Files\obs-studio, set:

$env:OPENSTREAM_OBS_INSTALL = "D:\Apps\obs-studio"

Local Android Build

Android release validation should use the real streaming build. Signed release validation requires a keystore:

cd android
$env:OPENSTREAM_RELEASE_KEYSTORE = "$PWD\openstream-release.keystore"
$env:OPENSTREAM_RELEASE_STORE_PASSWORD = "<store-password>"
$env:OPENSTREAM_RELEASE_KEY_ALIAS = "<key-alias>"
$env:OPENSTREAM_RELEASE_KEY_PASSWORD = "<key-password>"
.\gradlew.bat :app:assembleRelease

Do not pass -Popenstream.nonStreamingCiBuild=true for release artifacts. If signing secrets are unavailable, use :app:assembleDebug for local validation only; do not publish that APK as an update or release.

Release Checklist

  • Confirm the README links point to the release tag being published.
  • Confirm the setup guide links to the same APK, installer EXE, and plugin zip.
  • Confirm pytest, Android unit tests, lint, and both production builds passed.
  • Confirm openstream-android.apk.sha256 matches the APK and the apkSha256 metadata field.
  • Confirm the OBS installer checksum matches installerSha256 in openstream-obs-update.json.
  • Confirm OBS lists OpenStream and can still load saved legacy scene sources.
  • Confirm the Android APK is release-signed and installable over the previous public release.
  • Confirm protocol-affecting Android and OBS changes are released together and pass the old/new compatibility matrix.
  • Confirm the GitHub release assets are attached, not only source-code archives.
  • Confirm the repository website is set to https://openstream.pages.dev.
  • Confirm the release notes link users to docs/set-up.md.