mirror of
https://github.com/Toastconcern/FrameStudio.git
synced 2026-10-29 00:02:23 +01:00
ToastconcernandClaude Opus 5.5
d8e5d9e71e
v<VERSION>.<commits on main> (VERSION starts at 0.1), with release notes since the previous numbered release, marked as GitHub's latest release; only when no build failed, and a re-run leaves an existing one alone. The rolling "latest" pre-release stays: installed Studios and headsets update from it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
337 lines
14 KiB
YAML
337 lines
14 KiB
YAML
# Builds Frame Studio for every computer it runs on, plus a same-commit Frame Home payload, on branch pushes,
|
|
# pull requests, and by hand (Actions > build > Run workflow). A push to main replaces the Studio "latest" pre-release
|
|
# and includes the Frame Home installer. A tag "v*" publishes a versioned release containing both products.
|
|
name: build
|
|
|
|
on:
|
|
push:
|
|
branches: ['**']
|
|
tags: ['v*']
|
|
pull_request:
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
# A newer push to the same branch replaces a run still going (its builds would be out of date anyway).
|
|
concurrency:
|
|
group: build-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
# Every Studio build knows the commit it's from (studio/updater.h compares it with the latest release's).
|
|
env:
|
|
FRAME_BUILD: ${{ github.sha }}
|
|
FRAME_HOME_PAYLOAD_DIR: ${{ github.workspace }}/build/frame-home/payload
|
|
|
|
jobs:
|
|
linux:
|
|
name: Linux ${{ matrix.arch }}
|
|
needs: [frame-home]
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- { arch: x64, runner: ubuntu-24.04, extra: "" }
|
|
- { arch: arm64, runner: ubuntu-24.04-arm, extra: "" }
|
|
runs-on: ${{ matrix.runner }}
|
|
timeout-minutes: 45
|
|
env:
|
|
FRAME_USE_CCACHE: "1"
|
|
CCACHE_DIR: ${{ github.workspace }}/.ccache
|
|
CCACHE_MAXSIZE: 500M
|
|
CCACHE_COMPILERCHECK: content
|
|
APT_CACHE_DIR: ${{ github.workspace }}/.apt-cache
|
|
steps:
|
|
- name: Check out source
|
|
uses: actions/checkout@v4
|
|
- name: Restore compiler cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: ${{ github.workspace }}/.ccache
|
|
key: ccache-studio-linux-${{ matrix.arch }}-${{ github.sha }}
|
|
restore-keys: ccache-studio-linux-${{ matrix.arch }}-
|
|
- name: Restore apt package cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: .apt-cache/archives
|
|
key: apt-ubuntu-24.04-${{ matrix.arch }}-${{ hashFiles('.github/workflows/build.yml') }}
|
|
restore-keys: apt-ubuntu-24.04-${{ matrix.arch }}-
|
|
- name: Download Frame Home payload
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: FrameHome-payload
|
|
path: build/frame-home/payload
|
|
- name: Tools and X11 headers
|
|
run: |
|
|
sudo mkdir -p "$APT_CACHE_DIR/archives/partial"
|
|
sudo chown _apt:root "$APT_CACHE_DIR/archives/partial"
|
|
sudo apt-get update
|
|
sudo apt-get -o Dir::Cache::archives="$APT_CACHE_DIR/archives" install -y ccache ninja-build cmake libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxkbcommon-dev ${{ matrix.extra }}
|
|
sudo chown -R "$(id -u):$(id -g)" "$APT_CACHE_DIR/archives"
|
|
- name: Build
|
|
run: sh scripts/build-studio.sh linux-${{ matrix.arch }}
|
|
- name: Show compiler cache statistics
|
|
run: ccache --show-stats
|
|
- name: Upload Linux build
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: FrameStudio-linux-${{ matrix.arch }}
|
|
path: build/stage/FrameStudio-linux-${{ matrix.arch }}
|
|
|
|
windows:
|
|
name: Windows ${{ matrix.arch }}
|
|
needs: [frame-home]
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
arch: [x64, arm64]
|
|
runs-on: windows-latest
|
|
timeout-minutes: 45
|
|
steps:
|
|
- name: Check out source
|
|
uses: actions/checkout@v4
|
|
- name: Download Frame Home payload
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: FrameHome-payload
|
|
path: build/frame-home/payload
|
|
- name: Build (MSVC)
|
|
shell: cmd
|
|
run: studio\build_windows.bat ${{ matrix.arch }} "%GITHUB_WORKSPACE%\build\windows-${{ matrix.arch }}"
|
|
- name: Package
|
|
shell: pwsh
|
|
run: |
|
|
$name = "FrameStudio-windows-${{ matrix.arch }}"
|
|
$stage = "build/stage/$name"
|
|
New-Item -ItemType Directory -Force $stage | Out-Null
|
|
Copy-Item "build/windows-${{ matrix.arch }}/Frame Studio.exe" $stage
|
|
Copy-Item -Recurse "build/windows-${{ matrix.arch }}/frame" "$stage/frame"
|
|
Copy-Item LICENSE "$stage/LICENSE.txt"
|
|
- name: Upload Windows build
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: FrameStudio-windows-${{ matrix.arch }}
|
|
path: build/stage/FrameStudio-windows-${{ matrix.arch }}
|
|
|
|
macos:
|
|
name: macOS ${{ matrix.arch }}
|
|
needs: [frame-home]
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
- { arch: arm64, runner: macos-14 }
|
|
runs-on: ${{ matrix.runner }}
|
|
timeout-minutes: 45
|
|
env:
|
|
FRAME_USE_CCACHE: "1"
|
|
CCACHE_DIR: ${{ github.workspace }}/.ccache
|
|
CCACHE_MAXSIZE: 500M
|
|
CCACHE_COMPILERCHECK: content
|
|
steps:
|
|
- name: Check out source
|
|
uses: actions/checkout@v4
|
|
- name: Restore compiler cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: ${{ github.workspace }}/.ccache
|
|
key: ccache-studio-macos-${{ matrix.arch }}-${{ github.sha }}
|
|
restore-keys: ccache-studio-macos-${{ matrix.arch }}-
|
|
- name: Restore Homebrew package cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: ~/Library/Caches/Homebrew/downloads
|
|
key: brew-macos-${{ matrix.arch }}-${{ hashFiles('.github/workflows/build.yml') }}
|
|
restore-keys: brew-macos-${{ matrix.arch }}-
|
|
- name: Download Frame Home payload
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: FrameHome-payload
|
|
path: build/frame-home/payload
|
|
- name: Tools and MoltenVK (Vulkan on Metal, bundled into the app)
|
|
run: brew install ccache ninja molten-vk
|
|
- name: Build
|
|
run: sh scripts/build-studio.sh macos-${{ matrix.arch }}
|
|
- name: Show compiler cache statistics
|
|
run: ccache --show-stats
|
|
- name: Upload macOS build
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: FrameStudio-macos-${{ matrix.arch }}
|
|
path: build/stage/FrameStudio-macos-${{ matrix.arch }}
|
|
|
|
frame-home:
|
|
name: Build Frame Home payload
|
|
runs-on: ubuntu-24.04-arm
|
|
timeout-minutes: 45
|
|
env:
|
|
CCACHE_DIR: ${{ github.workspace }}/.ccache
|
|
CCACHE_MAXSIZE: 500M
|
|
CCACHE_COMPILERCHECK: content
|
|
APT_CACHE_DIR: ${{ github.workspace }}/.apt-cache
|
|
steps:
|
|
- name: Check out source
|
|
uses: actions/checkout@v4
|
|
- name: Restore compiler cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: ${{ github.workspace }}/.ccache
|
|
key: ccache-frame-home-arm64-${{ github.sha }}
|
|
restore-keys: ccache-frame-home-arm64-
|
|
- name: Restore apt package cache
|
|
uses: actions/cache@v5
|
|
with:
|
|
path: .apt-cache/archives
|
|
key: apt-ubuntu-24.04-arm64-${{ hashFiles('.github/workflows/build.yml') }}
|
|
restore-keys: apt-ubuntu-24.04-arm64-
|
|
- name: Install Frame Home build dependencies
|
|
run: |
|
|
set -euo pipefail
|
|
sudo mkdir -p "$APT_CACHE_DIR/archives/partial"
|
|
sudo chown _apt:root "$APT_CACHE_DIR/archives/partial"
|
|
sudo apt-get update
|
|
sudo apt-get -o Dir::Cache::archives="$APT_CACHE_DIR/archives" install -y ccache cmake ninja-build gcc-13 g++-13 glslc zip libdeflate-dev
|
|
sudo chown -R "$(id -u):$(id -g)" "$APT_CACHE_DIR/archives"
|
|
- name: Build payload and installer
|
|
run: sh scripts/build-frame-home.sh --ci
|
|
- name: Show compiler cache statistics
|
|
run: ccache --show-stats
|
|
- name: Upload Frame Home payload
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: FrameHome-payload
|
|
path: build/frame-home/payload
|
|
- name: Upload Frame Home installer
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: FrameHome-installer
|
|
path: build/frame-home/FrameHome-installer-stage/FrameHome-installer
|
|
if-no-files-found: error
|
|
release:
|
|
name: Publish
|
|
# "latest" gets every build that finished (a failed or still-slow platform just isn't in it); a version release
|
|
# needs them all. We don't wait on macOS: its runners can sit in GitHub's queue for hours, and since a push
|
|
# cancels the previous run, waiting meant no run ever reached this job. Both Mac builds still upload and are
|
|
# attached whenever they finish in time.
|
|
if: ${{ !cancelled() && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main') }}
|
|
needs: [linux, windows, frame-home]
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 20
|
|
permissions:
|
|
contents: write
|
|
id-token: write
|
|
attestations: write
|
|
env:
|
|
GH_TOKEN: ${{ github.token }}
|
|
REPO: ${{ github.repository }}
|
|
steps:
|
|
# Every push to main is also a numbered release: VERSION (major.minor) and the number of commits on main.
|
|
- name: Check out history (for the version number)
|
|
if: github.ref == 'refs/heads/main'
|
|
uses: actions/checkout@v4
|
|
with:
|
|
path: src
|
|
fetch-depth: 0
|
|
- name: Version
|
|
if: github.ref == 'refs/heads/main'
|
|
run: |
|
|
version="v$(tr -d ' \r\n' < src/VERSION).$(git -C src rev-list --count HEAD)"
|
|
echo "VERSION_TAG=$version" >> "$GITHUB_ENV"
|
|
echo "$version"
|
|
- name: Download Studio build artifacts
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
pattern: FrameStudio-*
|
|
path: dist
|
|
merge-multiple: false
|
|
- name: Download Frame Home payload
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: FrameHome-payload
|
|
path: ${{ runner.temp }}/frame-home-payload
|
|
- name: Download Frame Home installer
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: FrameHome-installer
|
|
path: dist/FrameHome-installer
|
|
- name: Rebuild release archives
|
|
run: |
|
|
for package in dist/FrameStudio-linux-*; do
|
|
[ -d "$package" ] || continue
|
|
name=${package##*/}
|
|
# (artifacts don't keep file modes: the program itself has to be executable again)
|
|
chmod +x "$package/Frame Studio"
|
|
if [ -d "$package/frame/bin" ]; then
|
|
chmod +x "$package/frame/install.sh" "$package/frame/bin/"*
|
|
fi
|
|
if [ -d "$package/pc/bin" ]; then
|
|
chmod +x "$package/pc/install.sh" "$package/pc/bin/"*
|
|
fi
|
|
tar -czf "dist/$name.tar.gz" -C dist "$name"
|
|
rm -rf "$package"
|
|
done
|
|
for package in dist/FrameStudio-windows-* dist/FrameStudio-macos-*; do
|
|
[ -d "$package" ] || continue
|
|
name=${package##*/}
|
|
if [ -d "$package/frame/bin" ]; then
|
|
chmod +x "$package/frame/install.sh" "$package/frame/bin/"*
|
|
fi
|
|
if [[ "$name" == FrameStudio-macos-* ]]; then
|
|
chmod +x "$package/Frame Studio.app/Contents/MacOS/Frame Studio"
|
|
fi
|
|
(cd dist && zip -qr "$name.zip" "$name")
|
|
rm -rf "$package"
|
|
done
|
|
chmod +x dist/FrameHome-installer/install-frame-home.sh \
|
|
dist/FrameHome-installer/payload/install.sh \
|
|
dist/FrameHome-installer/payload/bin/*
|
|
(cd dist && zip -qr FrameHome-installer.zip FrameHome-installer)
|
|
rm -rf dist/FrameHome-installer
|
|
python3 - <<'PY'
|
|
from pathlib import Path
|
|
from zipfile import ZipFile
|
|
|
|
for path in Path("dist").glob("*.zip"):
|
|
with ZipFile(path) as archive:
|
|
nested = [name for name in archive.namelist() if name.lower().endswith(".zip")]
|
|
if nested:
|
|
raise SystemExit(f"{path} contains nested ZIP files: {nested}")
|
|
PY
|
|
# What Frame Studio (studio/updater.h) and the headset's Environments panel check for updates: this commit,
|
|
# Frame Home's identity (a hash of the headset programs, the same one the panel works out for what's installed)
|
|
# and the files in this release.
|
|
- name: latest.json
|
|
run: |
|
|
home=$(cd "$RUNNER_TEMP/frame-home-payload" && sha256sum bin/frame-home bin/frame-switcher bin/fenv-tool layer/libframe_home_layer.so layer/env_ps.spv | cut -c1-64 | sha256sum | cut -c1-64)
|
|
files=$(ls dist | python3 -c 'import json, sys; print(json.dumps([l.strip() for l in sys.stdin if l.strip()]))')
|
|
printf '{"build": "%s", "home": "%s", "date": "%s", "files": %s}\n' "$GITHUB_SHA" "$home" "$(date -u +%Y-%m-%dT%H:%M:%SZ)" "$files" > dist/latest.json
|
|
cat dist/latest.json
|
|
- name: Attest Studio release archives
|
|
uses: actions/attest-build-provenance@v2
|
|
with:
|
|
subject-path: dist/FrameStudio-*
|
|
- name: Attest Frame Home installer
|
|
uses: actions/attest-build-provenance@v2
|
|
with:
|
|
subject-path: dist/FrameHome-installer.zip
|
|
- name: Version release (tag v*)
|
|
if: ${{ startsWith(github.ref, 'refs/tags/v') && !contains(needs.*.result, 'failure') }}
|
|
run: gh release create "${{ github.ref_name }}" dist/* --repo "$REPO" --title "Frame Studio ${{ github.ref_name }}" --generate-notes
|
|
# The numbered release (push to main): GitHub's "Latest release", with the changes since the previous numbered
|
|
# one. Only when no build failed; a re-run of the same commit finds it there and leaves it.
|
|
- name: Numbered release (push to main)
|
|
if: ${{ github.ref == 'refs/heads/main' && !contains(needs.*.result, 'failure') }}
|
|
run: |
|
|
if gh release view "$VERSION_TAG" --repo "$REPO" > /dev/null 2>&1; then echo "$VERSION_TAG is already released"; exit 0; fi
|
|
previous=$(gh release list --repo "$REPO" --exclude-pre-releases --limit 1 --json tagName --jq '.[0].tagName // empty')
|
|
gh release create "$VERSION_TAG" dist/* --repo "$REPO" --target "${{ github.sha }}" --latest \
|
|
--title "Frame Studio $VERSION_TAG" --generate-notes ${previous:+--notes-start-tag "$previous"}
|
|
# The rolling "latest" pre-release: where installed Studios and headsets look for updates (latest.json).
|
|
- name: Latest build (push to main)
|
|
if: github.ref == 'refs/heads/main'
|
|
run: |
|
|
gh release delete latest --repo "$REPO" --yes --cleanup-tag 2>/dev/null || true
|
|
gh release create latest dist/* --repo "$REPO" --prerelease --target "${{ github.sha }}" \
|
|
--title "Latest build (${GITHUB_SHA::7})" \
|
|
--notes "Built automatically from ${{ github.sha }} on $(date -u '+%Y-%m-%d %H:%M UTC'). Replaced by every push to main."
|