build(macos)!: add homebrew formula and drop dmg #2222

ReenigneArcher · 2024-03-06T03:00:41Z

Description

This PR will add a homebrew forumla for Sunshine.

Todo:

Adjust CI and CMake to configure the brew spec file, and build sunshine using the spec (similar to the Portfile)
Add a LizardByte homebrew repo, similar to https://github.com/LizardByte/jellyfin-plugin-repo
- Won't hold the action, as brew requires the forumlas to be in the main branch
- Done, see https://github.com/LizardByte/homebrew (action will take care of creating repo structure)
Create an action to use for publishing the final homebrew spec to the repo created
Update docs, specifically macOS installation instructions

References:

Screenshot

Issues Fixed or Closed

Fixes Improve MacOS packaging #186
Resolves Any interest in a Homebrew formula for sunshine #342
Resolves #391

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Dependency update (updates to dependencies)
Documentation update (changes to documentation)
Repository update (changes to repository files, e.g. .github/...)

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

I want maintainers to keep my branch updated

packaging/macos/sunshine.rb

ReenigneArcher · 2024-03-07T15:46:06Z

I think we should also drop the standard macOS build as part of this. It will save 3 runners, and the artifacts produced by the build are not actually usable due to missing deps and the linking used doesn't allow it to be standalone like on Windows.

The homebrew install will be very easy compared to the macports build as well... essentially it will be a single terminal command to install sunshine through homebrew.

ReenigneArcher · 2024-03-07T22:50:16Z

cmake/targets/common.cmake

 #WebUI build
 add_custom_target(web-ui ALL
        WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
        COMMENT "Installing NPM Dependencies and Building the Web UI"
-        COMMAND bash -c \"npm install && SUNSHINE_SOURCE_ASSETS_DIR=${SUNSHINE_SOURCE_ASSETS_DIR} SUNSHINE_ASSETS_DIR=${CMAKE_BINARY_DIR} npm run build\") # cmake-lint: disable=C0301
+        COMMAND bash -c \"npm install && SUNSHINE_BUILD_HOMEBREW=${NPM_BUILD_HOMEBREW} SUNSHINE_SOURCE_ASSETS_DIR=${NPM_SOURCE_ASSETS_DIR} SUNSHINE_ASSETS_DIR=${NPM_ASSETS_DIR} npm run build\") # cmake-lint: disable=C0301


vite build fails if we provide a full path to the directories

ReenigneArcher · 2024-03-07T22:50:44Z

packaging/macos/sunshine.rb

+class @PROJECT_NAME@ < Formula
+  desc "@PROJECT_DESCRIPTION@"
+  homepage "@PROJECT_HOMEPAGE_URL@"
+  url "@GITHUB_CLONE_URL@",
+    tag: "@GITHUB_BRANCH@"
+  version "@PROJECT_VERSION@"
+  license all_of: ["GPL-3.0-only"]
+  head "@GITHUB_CLONE_URL@"


The file is configured just like the Portfile, flatpak, etc.

packaging/macos/sunshine.rb

ReenigneArcher · 2024-03-07T22:52:05Z

packaging/macos/sunshine.rb

+  test do
+    # test that the binary runs at all
+    output = shell_output("#{bin}/sunshine --version").strip
+    puts output


without this the output is suppressed

ReenigneArcher · 2024-03-07T23:07:59Z

@RealHQ would you mind reviewing this?

homebrew repo will be here: https://github.com/LizardByte/homebrew

The action that publishes the tap has been tested here: https://github.com/LizardByte/homebrew-release-action/tree/tests

New docs for homebrew are here: https://lizardbyte--2222.org.readthedocs.build/projects/sunshine/en/2222/about/setup.html#install

And the generated spec file can be seen in the CI here: https://github.com/LizardByte/Sunshine/actions/runs/8195989432/job/22415345732?pr=2222#step:4:61

ReenigneArcher · 2024-03-08T02:40:48Z

The core parts of this PR will remain the same, but...

I think I'm going to modify the action to do more of the heavy lifting.

Provide it a specific formula as an input
Have the action run the install
Have the action run the tests
Audit the formula (https://docs.brew.sh/Formula-Cookbook#audit-the-formula)

And for the future:

Fork https://github.com/Homebrew/homebrew-core if it doesn't exist in the org already
Checkout the fork
Create a branch for the formula, and commit the changes
Create/update a PR to upstream

cgutman

Seems fine to me, though I'm by no means an expert in Homebrew packaging.

ReenigneArcher · 2024-03-09T15:19:35Z

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.18)

 # todo - set version to 0.0.0 once confident in automated versioning
 project(Sunshine VERSION 0.22.0
-        DESCRIPTION "Sunshine is a self-hosted game stream host for Moonlight."
+        DESCRIPTION "Self-hosted game stream host for Moonlight"


This was modified to appease the homebrew audit step. The same complaints were presented by the Macports team previously, and I think the Flatpak team.

tristan-k · 2024-07-20T15:24:35Z

Why isn't the thomebrew formula up to date with the latest sunshine.rb release ? There is also the homebrew head flag in case that it isn't updated because it is a beta releease.

brew tap LizardByte/homebrew
brew install --HEAD sunshine

ReenigneArcher · 2024-07-20T15:30:10Z

head only works if the build process hasn't changed

tristan-k · 2024-07-20T18:38:34Z

What a bummer. Is there another way to use the sunshine.rb with homebrew or some documentation?

ReenigneArcher · 2024-07-20T19:25:22Z

Latest stable version should work with brew

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 11 times, most recently from 00f41d2 to d2cc861 Compare March 7, 2024 03:47

ReenigneArcher commented Mar 7, 2024

View reviewed changes

packaging/macos/sunshine.rb Outdated Show resolved Hide resolved

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 8 times, most recently from ab5cbbb to 9a9911d Compare March 7, 2024 15:43

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 4 times, most recently from 911bcf6 to 7eaf4b4 Compare March 7, 2024 22:47

ReenigneArcher commented Mar 7, 2024

View reviewed changes

ReenigneArcher marked this pull request as ready for review March 7, 2024 22:52

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 2 times, most recently from 2bebc23 to e855534 Compare March 7, 2024 23:03

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 6 times, most recently from 394cd56 to 659e0d7 Compare March 8, 2024 01:13

ReenigneArcher added this to the v0.22.1 milestone Mar 8, 2024

ReenigneArcher requested a review from cgutman March 8, 2024 01:44

cgutman previously approved these changes Mar 8, 2024

View reviewed changes

ReenigneArcher dismissed cgutman’s stale review via c4864dd March 9, 2024 14:16

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch 3 times, most recently from 986a0c8 to 6e733aa Compare March 9, 2024 14:54

build(macos): add homebrew formula

066dfa8

ReenigneArcher force-pushed the build(macos)-add-homebrew-formula branch from 6e733aa to 066dfa8 Compare March 9, 2024 15:18

ReenigneArcher commented Mar 9, 2024

View reviewed changes

ReenigneArcher changed the title ~~build(macos): add homebrew formula~~ build(macos)!: add homebrew formula and drop dmg Mar 9, 2024

ReenigneArcher mentioned this pull request Mar 9, 2024

Improve MacOS packaging #186

Closed

ReenigneArcher merged commit 33e99e1 into nightly Mar 9, 2024
48 checks passed

ReenigneArcher deleted the build(macos)-add-homebrew-formula branch March 9, 2024 15:47

KuleRucket pushed a commit to KuleRucket/Sunshine that referenced this pull request Jun 6, 2024

build(macos)!: add homebrew formula and drop dmg (LizardByte#2222)

bd267a6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build(macos)!: add homebrew formula and drop dmg #2222

build(macos)!: add homebrew formula and drop dmg #2222

ReenigneArcher commented Mar 6, 2024 •

edited

Loading

ReenigneArcher commented Mar 7, 2024 •

edited

Loading

ReenigneArcher Mar 7, 2024

ReenigneArcher Mar 7, 2024

ReenigneArcher Mar 7, 2024

ReenigneArcher commented Mar 7, 2024

ReenigneArcher commented Mar 8, 2024

cgutman left a comment

ReenigneArcher Mar 9, 2024

tristan-k commented Jul 20, 2024 •

edited

Loading

ReenigneArcher commented Jul 20, 2024

tristan-k commented Jul 20, 2024

ReenigneArcher commented Jul 20, 2024

build(macos)!: add homebrew formula and drop dmg #2222

build(macos)!: add homebrew formula and drop dmg #2222

Conversation

ReenigneArcher commented Mar 6, 2024 • edited Loading

Description

Screenshot

Issues Fixed or Closed

Type of Change

Checklist

Branch Updates

ReenigneArcher commented Mar 7, 2024 • edited Loading

ReenigneArcher Mar 7, 2024

Choose a reason for hiding this comment

ReenigneArcher Mar 7, 2024

Choose a reason for hiding this comment

ReenigneArcher Mar 7, 2024

Choose a reason for hiding this comment

ReenigneArcher commented Mar 7, 2024

ReenigneArcher commented Mar 8, 2024

cgutman left a comment

Choose a reason for hiding this comment

ReenigneArcher Mar 9, 2024

Choose a reason for hiding this comment

tristan-k commented Jul 20, 2024 • edited Loading

ReenigneArcher commented Jul 20, 2024

tristan-k commented Jul 20, 2024

ReenigneArcher commented Jul 20, 2024

ReenigneArcher commented Mar 6, 2024 •

edited

Loading

ReenigneArcher commented Mar 7, 2024 •

edited

Loading

tristan-k commented Jul 20, 2024 •

edited

Loading