WIP: Moving to cpack in order to unify installers across all platforms #139

ABeltramo · 2022-04-23T09:56:47Z

Description

I'm moving package distribution to cpack which will unify the current .deb and .rpm generation and it'll enable creation of Windows Installers and Mac OSX bundles.
This should reduce considerably duplication of code.

Currently work in progress, needs testing on real deployments.

Issues Fixed or Closed

Fixes Consider new packaging strategy #61

Type of Change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

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 documentation blocks for new or existing components

ABeltramo · 2022-04-23T10:02:50Z

I'll modify the docs to reflect the change, if someone wants to try this out it's as simple as:

mkdir build # I like to put all the generated files inside here, so that we don't clutter the root
cd build
cmake ../
cpack -G DEB # you can also try RPM

ReenigneArcher

Thanks for working on this! Once you're happy with everything, CI will also need to be updated. Also, once the CI is updated, we can run it when you push new changes, and have downloadable artifacts from the workflow run.

Linux builds: https://github.com/SunshineStream/Sunshine/blob/c4054c75a7fdd0c336db326af5a77171db072e49/.github/workflows/CI.yml#L146

Windows build: https://github.com/SunshineStream/Sunshine/blob/c4054c75a7fdd0c336db326af5a77171db072e49/.github/workflows/CI.yml#L197

The final action in each job expects the release asset to be in the artifacts directory.

ReenigneArcher · 2022-04-23T15:27:48Z

CMakeLists.txt

+	set(CMAKE_INSTALL_PREFIX "/etc/sunshine")
+endif()
+
+include(CPack)


add new line at end of files

assets/linux-deb/conffiles

CMakeLists.txt

ReenigneArcher

Getting close!

ReenigneArcher · 2022-04-27T20:59:11Z

.github/workflows/CI.yml

+          cp Sunshine__.rpm ../artifacts/
+          cp Sunshine__.deb ../artifacts/


Same comment as windows regarding move.

Let's use these filenames:
sunshine.deb
sunshine.rpm

Also, while changes are being made, let's order them alphabetically. deb first, then rpm.

.github/workflows/CI.yml

ReenigneArcher · 2022-04-27T21:10:29Z

.github/workflows/CI.yml

+          mkdir artifacts
+


won't need this here

ReenigneArcher · 2022-04-27T21:11:39Z

.github/workflows/CI.yml

-      - name: Package Windows
-        run: |
-          cd sunshine-windows-build
-          del ..\assets\apps_linux.json
-          7z a sunshine-windows.zip ..\assets
-          7z a sunshine-windows.zip sunshine.exe
-          7z a sunshine-windows.zip tools\dxgi-info.exe
-          7z a sunshine-windows.zip tools\audio-info.exe
-          7z a sunshine-windows.zip tools\sunshinesvc.exe
-          7z a sunshine-windows.zip ..\tools\install-service.bat
-          7z a sunshine-windows.zip ..\tools\uninstall-service.bat
-          cd ..
-          mkdir artifacts
-          move "sunshine-windows-build\sunshine-windows.zip" "artifacts"
+          cpack
+
+          cp Sunshine__.exe ../artifacts


Let's keep the package step as we discussed. Would be good to have a portable version as well.

Probably doesn't make much difference, but I think it would be better (slightly faster) to use move... also let's rename the file to sunshine-windows-installer.exe

Probably makes most sense to have both cpack and the move in the package step.

- name: Package Windows run: | cd sunshine-windows-build cpack del ..\assets\apps_linux.json 7z a sunshine-windows.zip ..\assets 7z a sunshine-windows.zip sunshine.exe 7z a sunshine-windows.zip tools\dxgi-info.exe 7z a sunshine-windows.zip tools\audio-info.exe 7z a sunshine-windows.zip tools\sunshinesvc.exe 7z a sunshine-windows.zip ..\tools\install-service.bat 7z a sunshine-windows.zip ..\tools\uninstall-service.bat mkdir artifacts move "sunshine-windows.zip" "../artifacts" move "Sunshine__.exe" "../artifacts/sunshine-windows-installer.exe"

ReenigneArcher · 2022-04-27T21:37:57Z

CMakeLists.txt

+set(CPACK_PACKAGE_HOMEPAGE_URL "https://github.com/SunshineStream/Sunshine")
+set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
+set(CPACK_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/sunshine.png)
+set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}_${VERSION}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE}")


I'm guessing this needs to change to prevent this (same with start menu entry).

ReenigneArcher · 2022-04-27T21:38:29Z

CMakeLists.txt

+set(CPACK_PACKAGE_CONTACT "https://github.com/SunshineStream/Sunshine")
+set(CPACK_DEBIAN_PACKAGE_MAINTAINER "https://github.com/SunshineStream/Sunshine")
+set(CPACK_PACKAGE_DESCRIPTION "Gamestream host for Moonlight")
+set(CPACK_PACKAGE_HOMEPAGE_URL "https://github.com/SunshineStream/Sunshine")


https://sunshinestream.github.io

ReenigneArcher

There might be more, but this is what I found so far.

ReenigneArcher · 2022-04-29T20:26:29Z

.github/workflows/CI.yml

-          del ..\assets\apps_linux.json
-          7z a sunshine-windows.zip ..\assets
-          7z a sunshine-windows.zip sunshine.exe
-          7z a sunshine-windows.zip tools\dxgi-info.exe
-          7z a sunshine-windows.zip tools\audio-info.exe
-          7z a sunshine-windows.zip tools\sunshinesvc.exe
-          7z a sunshine-windows.zip ..\tools\install-service.bat
-          7z a sunshine-windows.zip ..\tools\uninstall-service.bat
-          cd ..
-          mkdir artifacts
-          move "sunshine-windows-build\sunshine-windows.zip" "artifacts"
-      - name: Upload Artifacts
+          cpack
+
+          mkdir -p artifacts/standalone
+          mkdir -p artifacts/web
+          mkdir -p artifacts/shaders/directx
+
+          # Installers
+          mv Sunshine__.exe artifacts/sunshine-windows-installer.exe
+
+          # Standalone
+          mv ../assets/web artifacts/web
+          mv tools artifacts/tools
+          mv ../assets/shaders/directx artifacts/shaders/directx
+          mv ../assets/apps_windows.json artifacts/apps_windows.json
+          mv ../assets/sunshine.conf artifacts/sunshine.conf
+          mv sunshine.exe artifacts/sunshine.exe


This won't work like this. We need only 2 files in the artifacts folders.

installer exe

zip (portable version as before)

This is because every file single in the assets directory will be uploaded as a release asset.

My code snip before should work (except the mkdir artifacts needed to be moved)

This should be pretty close #139 (comment)

ReenigneArcher · 2022-04-29T20:27:39Z

.github/workflows/CI.yml

+      - name: Upload Sunshine Installer
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: sunshine-windows-installer
+          path: artifacts/sunshine-windows-installer.exe


This won't be necessary because just using path: artifacts will upload all the files that exist in that folder (this will be the same behavior for the create release action)

The problem with this is that Github will make one .zip file that contains both the .exe installer and the .zip with the sunshine standalone package resulting in a 20MB zip to be donwloaded that basically contains everything twice just packaged in two different formats (see: https://github.com/ABeltramo/Sunshine/actions/runs/2249492914).

I think it's better to split them in two separate 10MB artifacts so that users can download only the one needed.

It only does it for artifacts though, not releases. Users are rarely downloading artifacts.

Just trying to keep the CI more simple as it's already overly complex.

ReenigneArcher · 2022-04-29T20:28:20Z

.github/workflows/CI.yml

+      - name: Upload Sunshine executable
        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
        uses: actions/upload-artifact@v3
        with:
-          name: sunshine-windows
-          path: artifacts/
+          name: sunshine-windows-standalone
+          path: artifacts/standalone


Revert this

ReenigneArcher · 2022-04-29T20:32:36Z

.github/workflows/CI.yml

@@ -32,7 +32,6 @@ jobs:
  check_versions:
    name: Check Versions
    runs-on: ubuntu-latest
-    needs: check_changelog


Why was this changed? It's required here.

Check changelog runs first (doesn't run except on PRs or Pulls into master branch). Makes sure that the version in the changelog was updated and is not equal to the latest released version.

Then check versions runs... makes sure that the version number in the CMakeLists.txt was updated.

.github/workflows/CI.yml

added default brew link libraries path

…release action at the end

…ent packages

ABeltramo · 2022-04-30T09:40:05Z

Current status:

rebased on top of latest nightly
fixed Github Actions to generate all packages, see: latest action
- Windows installer and standalone zip should be good to go
- Linux .deb and .rpm needs to be tested, appimage should be unchanged (unfortunately it's not supported by cpack)
- OSX bundle .dmg can be generated but I can't run Sunshine on my Macbook M1 (segfault), also executing a .app, while possible, feels odd because it doesn't open up a terminal automatically like on Windows.
Generated packages should be tested on different platforms, volunteers?

This could be reviewed and merged if you are in a rush to release this, but I would like to cleanup scripts/ to have one single docker container that can build .deb and .rpm so that users can still compile without having to install extra packages on the host.

There's also probably some documentation to be updated, I haven't looked into it yet.

Revert workflow logic

ReenigneArcher requested changes Apr 23, 2022

View reviewed changes

ReenigneArcher added pkg:rpm labels Apr 23, 2022

ReenigneArcher requested changes Apr 27, 2022

View reviewed changes

ReenigneArcher reviewed Apr 27, 2022

View reviewed changes

This was referenced Apr 29, 2022

Properly document run time dependencies #136

Closed

Intel QuickSync support #77

Closed

ReenigneArcher requested changes Apr 29, 2022

View reviewed changes

ABeltramo added 11 commits April 30, 2022 10:24

WIP: Moving to cpack in order to unify installers across all platforms

c4977b5

testing RPM package dependencies

2ea414d

feat: basic OSX .app generation

ffdcf0f

added default brew link libraries path

feat: created NSIS windows installer, fixed Linux packaging paths

e2bef75

feat: testing out CI building for new packages

cc2d982

feat: testing out a better CI workflow

4e4a5c8

fix: CI, better jobs dependencies

af342c8

fix: testing CI

6858f9c

CI: use cpack for windows 7Z, split back deb/rpm and appimage, moved …

5eb3e7c

…release action at the end

CI: windows build packaging to ZIP, split artifacts upload for differ…

dc4393a

…ent packages

win: installation directory fix

31f7faa

ABeltramo force-pushed the cpack branch from 2f68605 to 31f7faa Compare April 30, 2022 09:26

ReenigneArcher and others added 2 commits April 30, 2022 15:13

Revert workflow logic

2a69385

Merge pull request #1 from SunshineStream/add-cpack

6e2bb05

Revert workflow logic

ReenigneArcher mentioned this pull request Apr 30, 2022

Add cpack #144

Merged

5 tasks

ABeltramo closed this May 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Moving to cpack in order to unify installers across all platforms #139

WIP: Moving to cpack in order to unify installers across all platforms #139

ABeltramo commented Apr 23, 2022 •

edited

ABeltramo commented Apr 23, 2022

ReenigneArcher left a comment •

edited

ReenigneArcher Apr 23, 2022

ReenigneArcher left a comment

ReenigneArcher Apr 27, 2022

ReenigneArcher Apr 27, 2022

ReenigneArcher Apr 27, 2022

ReenigneArcher Apr 27, 2022

ReenigneArcher Apr 27, 2022

ReenigneArcher left a comment

ReenigneArcher Apr 29, 2022

ReenigneArcher Apr 29, 2022

ReenigneArcher Apr 29, 2022

ABeltramo Apr 30, 2022

ReenigneArcher Apr 30, 2022

ReenigneArcher Apr 29, 2022

ReenigneArcher Apr 29, 2022

ABeltramo commented Apr 30, 2022 •

edited

		cp Sunshine__.rpm ../artifacts/
		cp Sunshine__.deb ../artifacts/

WIP: Moving to cpack in order to unify installers across all platforms #139

WIP: Moving to cpack in order to unify installers across all platforms #139

Conversation

ABeltramo commented Apr 23, 2022 • edited

Description

Issues Fixed or Closed

Type of Change

Checklist

ABeltramo commented Apr 23, 2022

ReenigneArcher left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ReenigneArcher left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ReenigneArcher left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ABeltramo commented Apr 30, 2022 • edited

ABeltramo commented Apr 23, 2022 •

edited

ReenigneArcher left a comment •

edited

ABeltramo commented Apr 30, 2022 •

edited