-
-
Notifications
You must be signed in to change notification settings - Fork 987
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build(macos)!: add homebrew formula and drop dmg #2222
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -505,137 +505,96 @@ jobs: | |
discussionCategory: announcements | ||
prerelease: ${{ needs.setup_release.outputs.pre_release }} | ||
|
||
build_mac: | ||
build_mac_brew: | ||
needs: [check_changelog, setup_release] | ||
env: | ||
BOOST_VERSION: 1.83.0 | ||
strategy: | ||
fail-fast: false # false to test all, true to fail entire job if any fail | ||
matrix: | ||
include: | ||
# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#standard-github-hosted-runners-for-public-repositories | ||
# while GitHub has larger macOS runners, they are not available for our repos :( | ||
- os_version: "12" | ||
arch: "x86_64" | ||
release: true | ||
- os_version: "13" | ||
arch: "x86_64" | ||
- os_version: "14" | ||
arch: "arm64" | ||
name: macOS-${{ matrix.os_version }} ${{ matrix.arch }} | ||
name: Homebrew (macOS-${{ matrix.os_version }}) | ||
runs-on: macos-${{ matrix.os_version }} | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
submodules: recursive | ||
|
||
- name: Setup Dependencies MacOS | ||
- name: Setup Dependencies Homebrew | ||
run: | | ||
# install dependencies using homebrew | ||
brew install cmake | ||
|
||
- name: Configure formula | ||
run: | | ||
if [[ ${{ matrix.arch }} == "arm64" ]]; then | ||
brew_prefix="/opt/homebrew" | ||
# variables for formula | ||
branch=${GITHUB_HEAD_REF} | ||
|
||
# check the branch variable | ||
if [ -z "$branch" ] | ||
then | ||
echo "This is a PUSH event" | ||
clone_url=${{ github.event.repository.clone_url }} | ||
branch="${{ github.ref_name }}" | ||
else | ||
brew_prefix="/usr/local" | ||
echo "This is a PR event" | ||
clone_url=${{ github.event.pull_request.head.repo.clone_url }} | ||
branch="${{ github.event.pull_request.head.ref }}" | ||
fi | ||
echo "Branch: ${branch}" | ||
echo "Clone URL: ${clone_url}" | ||
|
||
# install dependencies using homebrew | ||
brew install cmake curl miniupnpc node openssl opus pkg-config | ||
|
||
# fix openssl header not found | ||
openssl_path=$(find ${brew_prefix}/Cellar -type d -name "openssl" -path "*/openssl@3/*/include" | head -n 1) | ||
echo "OpenSSL path: $openssl_path" | ||
ln -sf $openssl_path ${brew_prefix}/include/openssl | ||
ls -l ${brew_prefix}/include/openssl | ||
|
||
# fix opus header not found | ||
opus_path=$(find ${brew_prefix}/Cellar -type d -name "opus" -path "*/opus/*/include" | head -n 1) | ||
echo "Opus path: $opus_path" | ||
ln -sf $opus_path ${brew_prefix}/include/opus | ||
ls -l ${brew_prefix}/include/opus | ||
|
||
# fix miniupnpc header not found | ||
upnp_path=$(find ${brew_prefix}/Cellar -type d -name "miniupnpc" -path "*/miniupnpc/*/include" | head -n 1) | ||
echo "Miniupnpc path: $upnp_path" | ||
ln -sf $upnp_path ${brew_prefix}/include/miniupnpc | ||
ls -l ${brew_prefix}/include/miniupnpc | ||
|
||
- name: Install Boost | ||
# installing boost from homebrew takes 30 minutes in a GitHub runner | ||
run: | | ||
export BOOST_ROOT=${HOME}/boost-${BOOST_VERSION} | ||
|
||
# install boost | ||
wget \ | ||
https://github.com/boostorg/boost/releases/download/boost-${BOOST_VERSION}/boost-${BOOST_VERSION}.tar.gz \ | ||
--progress=bar:force:noscroll -q --show-progress | ||
tar xf boost-${BOOST_VERSION}.tar.gz | ||
cd boost-${BOOST_VERSION} | ||
|
||
# libdir should be set by --prefix but isn't | ||
./bootstrap.sh \ | ||
--prefix=${BOOST_ROOT} \ | ||
--libdir=${BOOST_ROOT}/lib \ | ||
--with-libraries=locale,log,program_options,system,thread | ||
./b2 headers | ||
./b2 install \ | ||
--prefix=${BOOST_ROOT} \ | ||
--libdir=${BOOST_ROOT}/lib \ | ||
-j$(sysctl -n hw.ncpu) \ | ||
link=shared,static \ | ||
variant=release \ | ||
cxxflags=-std=c++14 \ | ||
cxxflags=-stdlib=libc++ \ | ||
linkflags=-stdlib=libc++ | ||
|
||
# put boost in cmake prefix path | ||
echo "BOOST_ROOT=${BOOST_ROOT}" >> ${GITHUB_ENV} | ||
|
||
- name: Build MacOS | ||
env: | ||
BRANCH: ${{ github.head_ref || github.ref_name }} | ||
BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }} | ||
COMMIT: ${{ github.event.pull_request.head.sha || github.sha }} | ||
run: | | ||
mkdir build | ||
cd build | ||
cmake \ | ||
-DBUILD_WERROR=ON \ | ||
-DCMAKE_BUILD_TYPE=Release \ | ||
-DCMAKE_INSTALL_PREFIX=/usr \ | ||
-DSUNSHINE_ASSETS_DIR=local/sunshine/assets \ | ||
-DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \ | ||
-DGITHUB_BRANCH="${branch}" \ | ||
-DGITHUB_CLONE_URL="${clone_url}" \ | ||
-DSUNSHINE_CONFIGURE_HOMEBREW=ON \ | ||
-DSUNSHINE_CONFIGURE_ONLY=ON \ | ||
.. | ||
make -j $(sysctl -n hw.ncpu) | ||
cd .. | ||
|
||
- name: Package MacOS | ||
run: | | ||
mkdir -p artifacts | ||
cd build | ||
# copy formula to artifacts | ||
mkdir -p homebrew | ||
cp -f ./build/sunshine.rb ./homebrew/sunshine.rb | ||
|
||
# package | ||
cpack -G DragNDrop | ||
mv ./cpack_artifacts/Sunshine.dmg \ | ||
../artifacts/sunshine-macos-${{ matrix.os_version }}-${{ matrix.arch }}.dmg | ||
# testing | ||
cat ./homebrew/sunshine.rb | ||
|
||
- name: Upload Artifacts | ||
if: ${{ matrix.release }} | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: sunshine-macos-${{ matrix.os_version }}-${{ matrix.arch }} | ||
path: artifacts/ | ||
name: sunshine-homebrew | ||
path: homebrew/ | ||
|
||
- name: Create/Update GitHub Release | ||
if: ${{ needs.setup_release.outputs.create_release == 'true' }} | ||
uses: ncipollo/release-action@v1 | ||
- name: Should Publish Homebrew Formula | ||
id: homebrew_publish | ||
run: | | ||
PUBLISH=false | ||
if [[ \ | ||
"${{ matrix.release }}" == "true" && \ | ||
"${{ github.repository_owner }}" == "LizardByte" && \ | ||
"${{ needs.setup_release.outputs.create_release }}" == "true" && \ | ||
"${{ github.ref }}" == "refs/heads/master" \ | ||
]]; then | ||
PUBLISH=true | ||
fi | ||
|
||
echo "publish=${PUBLISH}" >> $GITHUB_OUTPUT | ||
|
||
- name: Validate and Publish Homebrew Formula | ||
uses: LizardByte/[email protected] | ||
with: | ||
name: ${{ needs.setup_release.outputs.release_name }} | ||
tag: ${{ needs.setup_release.outputs.release_tag }} | ||
commit: ${{ needs.setup_release.outputs.release_commit }} | ||
artifacts: "*artifacts/*" | ||
formula_file: ${{ github.workspace }}/homebrew/sunshine.rb | ||
git_email: ${{ secrets.GH_BOT_EMAIL }} | ||
git_username: ${{ secrets.GH_BOT_NAME }} | ||
publish: ${{ steps.homebrew_publish.outputs.publish }} | ||
token: ${{ secrets.GH_BOT_TOKEN }} | ||
allowUpdates: true | ||
body: ${{ needs.setup_release.outputs.release_body }} | ||
discussionCategory: announcements | ||
prerelease: ${{ needs.setup_release.outputs.pre_release }} | ||
|
||
build_mac_port: | ||
needs: [check_changelog, setup_release] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,8 +37,19 @@ endif() | |
|
||
target_compile_options(sunshine PRIVATE $<$<COMPILE_LANGUAGE:CXX>:${SUNSHINE_COMPILE_OPTIONS}>;$<$<COMPILE_LANGUAGE:CUDA>:${SUNSHINE_COMPILE_OPTIONS_CUDA};-std=c++17>) # cmake-lint: disable=C0301 | ||
|
||
# Homebrew build fails the vite build if we set these environment variables | ||
if(${SUNSHINE_BUILD_HOMEBREW}) | ||
set(NPM_SOURCE_ASSETS_DIR "") | ||
set(NPM_ASSETS_DIR "") | ||
set(NPM_BUILD_HOMEBREW "true") | ||
else() | ||
set(NPM_SOURCE_ASSETS_DIR ${SUNSHINE_SOURCE_ASSETS_DIR}) | ||
set(NPM_ASSETS_DIR ${CMAKE_BINARY_DIR}) | ||
set(NPM_BUILD_HOMEBREW "") | ||
endif() | ||
|
||
#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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. vite build fails if we provide a full path to the directories |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
require "language/node" | ||
|
||
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@", branch: "nightly" | ||
|
||
depends_on "boost" => :build | ||
depends_on "cmake" => :build | ||
depends_on "pkg-config" => :build | ||
depends_on "curl" | ||
depends_on "miniupnpc" | ||
depends_on "node" | ||
depends_on "openssl" | ||
depends_on "opus" | ||
ReenigneArcher marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
def install | ||
args = %W[ | ||
-DBUIld_WERROR=ON | ||
-DCMAKE_INSTALL_PREFIX=#{prefix} | ||
-DOPENSSL_ROOT_DIR=#{Formula["openssl"].opt_prefix} | ||
-DSUNSHINE_ASSETS_DIR=sunshine/assets | ||
-DSUNSHINE_BUILD_HOMEBREW=ON | ||
] | ||
system "cmake", "-S", ".", "-B", "build", *std_cmake_args, *args | ||
|
||
cd "build" do | ||
system "make", "-j" | ||
system "make", "install" | ||
end | ||
end | ||
|
||
service do | ||
run [opt_bin/"sunshine", "~/.config/sunshine/sunshine.conf"] | ||
end | ||
|
||
def caveats | ||
<<~EOS | ||
Thanks for installing @PROJECT_NAME@! | ||
|
||
To get started, review the documentation at: | ||
https://docs.lizardbyte.dev/projects/sunshine/en/latest/ | ||
|
||
Sunshine can only access microphones on macOS due to system limitations. | ||
To stream system audio use "Soundflower" or "BlackHole". | ||
|
||
Gamepads are not currently supported on macOS. | ||
EOS | ||
end | ||
|
||
test do | ||
# test that the binary runs at all | ||
output = shell_output("#{bin}/sunshine --version").strip | ||
puts output | ||
|
||
# TODO: add unit tests | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.