This guide shows how to create a new release that the built-in update system will detect and offer to users.
-
Tag the version:
git tag v1.0.4 # Increment minor version git push origin v1.0.4 -
Build with version from tag:
./master_build.sh # Will automatically use v1.0.4 from git tag -
Package for distribution:
zip -r UnifiedAudioControl-v1.0.4.zip UnifiedAudioControl.app
-
Create GitHub release:
- Go to: https://github.com/akeslo/Unified-Audio-Control/releases/new
- Choose tag:
v1.0.4 - Title:
Version 1.0.4or descriptive name - Description: Add release notes (shown to users in update dialog)
- Attach:
UnifiedAudioControl-v1.0.4.zip - Publish (not Draft)
-
Done! Users' apps will detect the new version automatically.
Follow semantic versioning: MAJOR.MINOR.PATCH
- MAJOR: Breaking changes (1.x.x → 2.0.0)
- MINOR: New features, non-breaking (1.2.x → 1.3.0)
- PATCH: Bug fixes (1.2.3 → 1.2.4)
Tip
User preference is to increment minor version for most releases (e.g., 1.2 → 1.3)
Write release notes that will appear in the update dialog:
## What's New
- Added support for external display volume control
- Fixed HUD display on secondary monitors
- Improved Bluetooth device name detection
## Bug Fixes
- Resolved issue with mute state persistence
- Fixed memory leak in audio device monitoringUse clear, user-friendly language. These notes appear in the app's update dialog!
After publishing a release:
-
Temporarily downgrade your local version in
master_build.sh:VERSION="1.0.3" # Or earlier than published release
-
Rebuild the app with older version number
-
Launch and open Preferences → Updates
-
Click "Check for Updates"
-
Verify the new release is detected and offered
-
Restore the VERSION in build script or let it auto-detect from git tags
Update not detected?
- Ensure release is Published (not Draft)
- Verify release is not marked as Pre-release
- Check version tag format:
v1.0.4or1.0.4(both work) - Confirm
.zipfile is attached to the release
Download fails?
- Release must include a
.zipfile as an asset - Asset name should end with
.zip - File must contain
UnifiedAudioControl.appbundle
Version comparison wrong?
- Ensure tags follow semantic versioning
- Use dots between numbers:
1.0.4not1.04 - Tags with
vprefix work fine:v1.0.4