This is step 1 of the Companion release flow.
Use this workflow to create the published Companion release assets for one version. GitHub Actions displays this workflow as Release: Build Companion Artifact. It builds release artifacts and updates a draft GitHub Release, but it does not decide which update channels see that release.
Use It When
Run the build workflow when:
- You want to publish a new Companion version.
- You want fresh installer and updater artifacts in the public Companion release repository.
- You are preparing a release that may later be promoted to
test,beta,stable, or Sambee download metadata.
Do not use this workflow to change channel visibility.
That is the job of Release: Promote Companion Release.
Input
The manual workflow exposes one checkbox per platform:
| Input | What it means | Typical usage |
|---|---|---|
build_all_platforms | Include every supported platform in one run. | Check it for a normal full release. |
build_linux_x64 | Include the Linux x64 build. | Check it when you need Linux release assets. |
build_macos_arm64 | Include the macOS ARM64 build. | Check it when you need Apple Silicon macOS release assets. |
build_windows_x64 | Include the Windows x64 build. | Check it when you need the standard Windows desktop release assets. |
build_windows_arm64 | Include the Windows ARM64 build. | Check it when you need Windows on ARM release assets. |
Current platform checkboxes are:
build_all_platformsbuild_linux_x64build_macos_arm64build_windows_x64build_windows_arm64
If you check build_all_platforms, the workflow builds the full matrix and ignores the per-platform checkboxes.
If you leave every checkbox cleared, the workflow does not build anything.
Check only the platforms you want when you deliberately need a partial release.
What It Does
Before packaging, the workflow:
- Checks out the main repository.
- Runs version-sync verification.
- Builds the platform matrix derived from the checked boxes.
- Uses Tauri packaging to upload assets into a draft release in
helgeklein/sambee-companion.
The build matrix is currently configured for:
- Linux x64.
- macOS ARM64.
- Windows x64.
- Windows ARM64.
If you build only a subset, the resulting release exposes only that subset. Promotion works from the assets actually present in the published release, not from an assumed full matrix.
Published Output
The workflow publishes assets into a draft GitHub Release in helgeklein/sambee-companion.
That release can contain:
- Installer assets.
- Tauri updater bundles.
.sigfiles for updater verification.- Release notes.
The workflow uses the tag format companion-vX.Y.Z.
Channel visibility is still unset at this stage. The build is only a published candidate until a later promotion updates the feed files.
Review Before Publish
Before you publish the draft release, verify:
- The version metadata is correct.
- The expected platform assets are present.
- The updater bundle and
.sigpairs look complete for the platforms you expect to promote. - The release notes are acceptable for public distribution.
If the draft contents are wrong, fix the release process and produce a new release instead of trying to patch channel metadata around a bad artifact set.
Run the Workflow
Use this order when you are preparing a Companion release:
- Merge the version-sync changes for the release you want to ship.
- Start
Release: Build Companion Artifactfrom the commit you want to release. - Check
build_all_platformsfor a normal full release, or check only the specific platform boxes you want for a partial release. If you leave all boxes cleared, the workflow skips artifact builds. - Wait for the workflow to update the draft release in
helgeklein/sambee-companion. - Review the uploaded assets and publish the draft release.
- Continue with Promote Companion Release .