shadowdaoandClaude Sonnet 5
104326d05a
Build / macOS (macos-latest) (push) Successful in 29s
Build / Linux (ubuntu-24.04) (push) Successful in 49s
Build / Windows (windows-latest) (push) Successful in 2m50s
Release / macOS (macos-latest) (push) Successful in 33s
Release / Linux (ubuntu-24.04) (push) Successful in 56s
Release / Windows (windows-latest) (push) Successful in 3m20s
Release / Create Gitea Release (draft) (push) Successful in 19s
The WebRTC/OpenH264 attribution question tracked as "C1" throughout README, third_party/livekit/README.md, the release-notes template, and both workflow header comments is the project owner's call, and it has been made -- own sign-off given and reaffirmed. Remove the gate language and the extended research writeup from release-facing docs; keep the actual LICENSE/NOTICE files themselves (Apache-2.0 requires shipping those regardless of any of this). Also simplify the release notes' install instructions per owner request: point at each platform's default OBS plugins folder rather than walking through verbose per-platform copy/extract instructions -- the archives already extract straight into place (prior commit), so a short pointer is all that's needed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RL8abRmgFXkVASHkkqiJbE
110 lines
4.2 KiB
Bash
Executable File
110 lines
4.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Creates a (draft) Gitea Release for the tag that triggered
|
|
# .gitea/workflows/release.yml, and uploads every archive in $DIST_DIR as a
|
|
# release asset. Draft because nobody has run this plugin in the OBS GUI on
|
|
# any platform yet -- a human still opens it and clicks Publish once that's
|
|
# no longer true (or once they're satisfied regardless).
|
|
#
|
|
# Required env: GITEA_TOKEN, SERVER, OWNER, REPO, TAG, SHA, DIST_DIR
|
|
# Optional env: MACOS_BUNDLE_FOUND ("true"/"false", default "false")
|
|
set -euo pipefail
|
|
|
|
: "${GITEA_TOKEN:?}"
|
|
: "${SERVER:?}"
|
|
: "${OWNER:?}"
|
|
: "${REPO:?}"
|
|
: "${TAG:?}"
|
|
: "${SHA:?}"
|
|
: "${DIST_DIR:?}"
|
|
MACOS_BUNDLE_FOUND="${MACOS_BUNDLE_FOUND:-false}"
|
|
|
|
if [ "${MACOS_BUNDLE_FOUND}" = "true" ]; then
|
|
MACOS_NOTE="This archive contains a \`.plugin\` bundle."
|
|
else
|
|
MACOS_NOTE="This archive is packaged as a bare \`streamer-tools-camera.so\` (the layout \`build/package/\` currently produces on macOS), **not** an OBS.app-loadable \`.plugin\` bundle. It will not load in the OBS GUI as-is -- see the \"macOS packaging gap\" section of \`README.md\`."
|
|
fi
|
|
|
|
NOTES_FILE="$(mktemp)"
|
|
cat > "${NOTES_FILE}" <<EOF
|
|
# streamer-tools Camera Plugin -- ${TAG}
|
|
|
|
Built from commit \`${SHA}\`.
|
|
|
|
**Nobody has yet run this plugin in the OBS GUI, on any platform.** See "What
|
|
is verified, and how" in \`README.md\` for exactly what has and has not been
|
|
checked, including which claims are backed by automated tests versus a human
|
|
watching OBS. This is why the release is a draft -- open it and click Publish
|
|
once you're satisfied.
|
|
|
|
| Platform | Archive | Notes |
|
|
|---|---|---|
|
|
| Linux (x64) | \`streamer-tools-camera-${TAG}-linux-x64.zip\` | Functionally complete and verified end to end against a real LiveKit server and a real libobs (see README); OBS GUI itself still unverified |
|
|
| Windows (x64) | \`streamer-tools-camera-${TAG}-windows-x64.zip\` | Built and tested by this workflow's Windows job; the WinHTTP backend has never been exercised against a real streamer-tools server, only a loopback test server -- see README's Windows CI section |
|
|
| macOS | \`streamer-tools-camera-${TAG}-macos.zip\` | Built and tested by this workflow's macOS job. ${MACOS_NOTE} |
|
|
|
|
## Installing
|
|
|
|
Extract the archive into your OBS plugins folder for your platform (the
|
|
default locations are easy to find online -- typically
|
|
\`~/.config/obs-studio/plugins/\` on Linux, \`%APPDATA%\\obs-studio\\plugins\\\`
|
|
on Windows, \`~/Library/Application Support/obs-studio/plugins/\` on macOS).
|
|
Each archive's top-level folder already matches the shape OBS expects there,
|
|
so extracting is the whole install step. Then in OBS: Sources -> \`+\` ->
|
|
"streamer-tools Camera" -> fill in the server URL, room slug and read key
|
|
from the room's settings page -> "Refresh camera list" -> pick a camera.
|
|
|
|
## What this is
|
|
|
|
Native OBS Studio source plugin that pulls streamer-tools camera feeds
|
|
directly from LiveKit over WebRTC. See \`README.md\` in the repository for
|
|
the full design, what is and is not verified, and current CI status.
|
|
EOF
|
|
|
|
echo "----- release notes -----"
|
|
cat "${NOTES_FILE}"
|
|
echo "--------------------------"
|
|
|
|
BODY_JSON="$(python3 - "$TAG" "$NOTES_FILE" <<'PYEOF'
|
|
import json, sys
|
|
tag, notes_file = sys.argv[1], sys.argv[2]
|
|
with open(notes_file) as f:
|
|
notes = f.read()
|
|
print(json.dumps({
|
|
"tag_name": tag,
|
|
"name": tag,
|
|
"body": notes,
|
|
"draft": True,
|
|
"prerelease": False,
|
|
}))
|
|
PYEOF
|
|
)"
|
|
|
|
echo "Creating release for tag ${TAG} ..."
|
|
RESP="$(curl -sS -f -X POST \
|
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
-H "Content-Type: application/json" \
|
|
-d "${BODY_JSON}" \
|
|
"${SERVER}/api/v1/repos/${OWNER}/${REPO}/releases")"
|
|
|
|
RELEASE_ID="$(python3 -c 'import json,sys; print(json.load(sys.stdin)["id"])' <<<"${RESP}")"
|
|
echo "Created release id ${RELEASE_ID} (draft)."
|
|
|
|
shopt -s nullglob
|
|
ASSETS=("${DIST_DIR}"/*)
|
|
if [ "${#ASSETS[@]}" -eq 0 ]; then
|
|
echo "::error::no archives found in ${DIST_DIR} -- nothing to upload."
|
|
exit 1
|
|
fi
|
|
|
|
for f in "${ASSETS[@]}"; do
|
|
name="$(basename "${f}")"
|
|
echo "Uploading ${name} ..."
|
|
curl -sS -f -X POST \
|
|
-H "Authorization: token ${GITEA_TOKEN}" \
|
|
-F "attachment=@${f}" \
|
|
"${SERVER}/api/v1/repos/${OWNER}/${REPO}/releases/${RELEASE_ID}/assets?name=${name}" \
|
|
> /dev/null
|
|
done
|
|
|
|
echo "Done. Draft release: ${SERVER}/${OWNER}/${REPO}/releases/${RELEASE_ID}"
|