Release build squashed

2024-06-29 13:45:23 -06:00
parent 2eb402ebb3
commit 86df5e0c53
4 changed files with 310 additions and 28 deletions
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -0,0 +1,147 @@
+on:
+  push:
+    branches:
+      - builds
+      - builds2
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - builds
+jobs:
+  release:
+    env:
+      BREW_PREFIX: ${{ matrix.os.name == 'macos' && matrix.os.version == '14' && 'arch -arm64' || ''}}
+      MACOSX_DEPLOYMENT_TARGET: 10.15
+      BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}
+      PROD_MACOS_CERTIFICATE: '${{ secrets.PROD_MACOS_CERTIFICATE }}'
+      PROD_MACOS_CERTIFICATE_PWD: '${{ secrets.PROD_MACOS_CERTIFICATE_PWD }}'
+      PROD_MACOS_CERTIFICATE_NAME: '${{ secrets.PROD_MACOS_CERTIFICATE_NAME }}'
+      PROD_MACOS_CI_KEYCHAIN_PWD: '${{ secrets.PROD_MACOS_CI_KEYCHAIN_PWD }}'
+      PROD_MACOS_NOTARIZATION_APPLE_ID: '${{ secrets.PROD_MACOS_NOTARIZATION_APPLE_ID }}'
+      PROD_MACOS_NOTARIZATION_TEAM_ID: '${{ secrets.PROD_MACOS_NOTARIZATION_TEAM_ID }}'
+      PROD_MACOS_NOTARIZATION_PWD: '${{ secrets.PROD_MACOS_NOTARIZATION_PWD }}'
+      VCPKG_BINARY_SOURCES: "clear;x-gha,readwrite"
+      DEBUG_FLAG: ${{ matrix.configuration == 'Debug' && 'true' || 'false' }}
+      BUILD_OS: ${{ matrix.os.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - name: macos
+          suffix: '-intel'
+          version: 12
+          scons-script: './.github/workflows/scripts/mac/scons-build.sh'
+          path-separator: ':'
+        - name: macos
+          suffix: '-silicon'
+          version: 14
+          scons-script: './.github/workflows/scripts/mac/scons-build.sh'
+          path-separator: ':'
+        - name: ubuntu
+          suffix: ''
+          version: 22.04
+          scons-script: scons
+          path-separator: ':'
+        - name: windows
+          suffix: ''
+          version: 2019
+          scons-script: './.github/workflows/scripts/win/scons-build.bat'
+          path-separator: ';'
+        boost-version:
+        - 1.85.0
+        sfml-version:
+        - 2.6.1
+        configuration:
+        - Release
+        - Debug
+    runs-on: '${{ matrix.os.name }}-${{ matrix.os.version }}'
+    steps:
+      - run: echo $DEBUG_FLAG
+      - name: Export GitHub Actions cache environment variables
+        uses: actions/github-script@v7
+        with:
+          script: "core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || ''); core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');"
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: CMake zlib for linux
+        run: cmake -S . -B build
+        working-directory: deps/zlib
+        if: ${{ matrix.os.name == 'ubuntu' }}
+      - name: CMake zlib for windows
+        run: cmake -S . -B build -D CMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded
+        working-directory: deps/zlib
+        if: ${{ matrix.os.name == 'windows' }}
+      - name: Build zlib for linux
+        run: make && sudo make install
+        working-directory: deps/zlib/build
+        if: ${{ matrix.os.name == 'ubuntu' }}
+      - name: Build zlib for windows
+        run: './.github/workflows/scripts/win/zlib-build.bat x64'
+        if: ${{ matrix.os.name == 'windows' }}
+
+
+      - name: Build Boost (fork)
+        id: boost-fork
+        uses: NQNStudios/build-boost@v1
+        with:
+          version: ${{ matrix.boost-version }}
+          libraries: filesystem system
+          platform: x64
+          configuration: ${{ matrix.configuration }}
+          static: ${{ matrix.os.name == 'windows' }}
+        if: ${{ matrix.os.name == 'macos' }}
+      - name: Build Boost
+        id: boost
+        uses: egor-tensin/build-boost@v1
+        with:
+          version: ${{ matrix.boost-version }}
+          libraries: filesystem system
+          platform: x64
+          configuration: ${{ matrix.configuration }}
+          static: ${{ matrix.os.name == 'windows' }}
+        if: ${{ matrix.os.name != 'macos' }}
+
+      - name: Build SFML
+        id: sfml
+        uses: NQNStudios/install-sfml@v1
+        with:
+          sfml: ${{ matrix.sfml-version }}
+          config: ${{ matrix.configuration }}
+      - name: Windows build dependencies
+        run: 'vcpkg install libxml2 && pip install scons'
+        if: ${{ matrix.os.name == 'windows' }}
+      - name: Mac build dependencies
+        run: brew install scons
+        if: ${{ matrix.os.name == 'macos' }}
+      - name: Linux build dependencies
+        run: sudo apt-get update && sudo apt-get install scons libxml2-utils zenity
+        if: ${{ matrix.os.name == 'ubuntu' }}
+      - name: Install TGUI
+        run: 'sudo ./.github/workflows/scripts/linux/install-tgui.sh'
+        if: ${{ matrix.os.name == 'ubuntu' }}
+      - name: Build
+        run: '${{ matrix.os.scons-script }} INCLUDEPATH="${{ steps.boost.outputs.root }}${{ steps.boost-fork.outputs.root }}${{ matrix.os.path-separator }}${{steps.sfml.outputs.path}}/include" LIBPATH="${{ steps.boost.outputs.librarydir }}${{ steps.boost-fork.outputs.librarydir }}${{ matrix.os.path-separator }}${{steps.sfml.outputs.path}}/lib${{ matrix.os.path-separator }}/usr/local/lib" FRAMEWORKPATH="${{steps.sfml.outputs.path}}/lib" test=false debug=$DEBUG_FLAG'
+        shell: bash
+      - name: Codesign and notarize
+        run: './.github/workflows/scripts/mac/sign-apps.sh'
+        if: ${{ matrix.os.name == 'macos' }}
+      - name: 'Tar files'
+        run: 'tar -cvf cboe-${{ matrix.os.name }}${{matrix.os.suffix}}-${{ matrix.configuration }}.tar "Blades of Exile"'
+        working-directory: '${{ github.workspace }}/build'
+      - name: 'Upload Artifact'
+        uses: actions/upload-artifact@v4
+        with:
+          name: cboe-${{ matrix.os.name }}${{matrix.os.suffix}}-${{ matrix.configuration }}
+          path: '${{ github.workspace }}/build/cboe-${{ matrix.os.name }}${{matrix.os.suffix}}-${{ matrix.configuration }}.tar'
+      - name: Github release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: '${{ github.workspace }}/build/cboe-${{ matrix.os.name }}${{matrix.os.suffix}}-${{ matrix.configuration }}.tar'
+        if: ${{ startsWith(github.ref, 'refs/tags/') }}
+      - name: 'Itch.io release'
+        run: './.github/workflows/scripts/butler_push.sh'
+        shell: bash
+        if: ${{ startsWith(github.ref, 'refs/tags/') && matrix.configuration == 'Release' && matrix.os.name != 'macos' }}
--- a/.github/workflows/scripts/butler_push.sh
+++ b/.github/workflows/scripts/butler_push.sh
@@ -0,0 +1,28 @@
+#! /bin/bash
+
+butler_channel=""
+butler_exe=""
+release_dir=""
+if [ "$BUILD_OS" = "ubuntu" ]; then
+    butler_channel=linux-amd64
+    butler_exe=butler
+    release_dir="linux"
+elif [ "$BUILD_OS" = "windows" ]; then
+    butler_channel=windows-amd64
+    butler_exe=butler.exe
+    release_dir="windows"
+elif [ "$BUILD_OS" = "macos" ]; then
+    butler_channel=darwin-amd64
+    butler_exe=butler
+    release_dir="macos"
+fi
+
+# -L follows redirects
+# -O specifies output name
+curl -L -o butler.zip https://broth.itch.ovh/butler/${butler_channel}/LATEST/archive/default
+unzip butler.zip
+# GNU unzip tends to not set the executable bit even though it's set in the .zip
+chmod +x ${butler_exe}
+# just a sanity check run (and also helpful in case you're sharing CI logs)
+./${butler_exe} -V
+./${butler_exe} push "build/Blades of Exile/" nqn/blades-of-exile:${butler_channel}
--- a/.github/workflows/scripts/mac/sign-apps.sh
+++ b/.github/workflows/scripts/mac/sign-apps.sh
@@ -0,0 +1,64 @@
+#! /bin/bash
+
+# CODE-SIGNING STEP
+# Original Source: https://federicoterzi.com/blog/automatic-code-signing-and-notarization-for-macos-apps-using-github-actions/
+# Modified by NQNStudios
+
+# Turn our base64-encoded certificate back to a regular .p12 file
+
+echo $PROD_MACOS_CERTIFICATE | base64 --decode > certificate.p12
+
+# We need to create a new keychain, otherwise using the certificate will prompt
+# with a UI dialog asking for the certificate password, which we can't
+# use in a headless CI environment
+
+security create-keychain -p "$PROD_MACOS_CI_KEYCHAIN_PWD" build.keychain
+security default-keychain -s build.keychain
+security unlock-keychain -p "$PROD_MACOS_CI_KEYCHAIN_PWD" build.keychain
+security import certificate.p12 -k build.keychain -P "$PROD_MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
+security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$PROD_MACOS_CI_KEYCHAIN_PWD" build.keychain
+
+sign() {
+    APP_PATH="build/Blades of Exile/$1.app"
+
+    # We finally codesign our app bundle, specifying the Hardened runtime option
+
+    /usr/bin/codesign --force -s "$PROD_MACOS_CERTIFICATE_NAME" --options runtime "$APP_PATH"/Contents/Frameworks/*.dylib -v
+    /usr/bin/codesign --force -s "$PROD_MACOS_CERTIFICATE_NAME" --options runtime "$APP_PATH"/Contents/Frameworks/*.framework -v
+    /usr/bin/codesign --force -s "$PROD_MACOS_CERTIFICATE_NAME" --options runtime "$APP_PATH/Contents/Info.plist" -v
+
+    /usr/bin/codesign --force -s "$PROD_MACOS_CERTIFICATE_NAME" --options runtime "$APP_PATH" -v
+
+    # NOTARIZATION STEP
+    # (same source)
+
+    # Store the notarization credentials so that we can prevent a UI password dialog
+    # from blocking the CI
+
+    echo "Create keychain profile"
+    xcrun notarytool store-credentials "notarytool-profile" --apple-id "$PROD_MACOS_NOTARIZATION_APPLE_ID" --team-id "$PROD_MACOS_NOTARIZATION_TEAM_ID" --password "$PROD_MACOS_NOTARIZATION_PWD"
+
+    # We can't notarize an app bundle directly, but we need to compress it as an archive.
+    # Therefore, we create a zip file containing our app bundle, so that we can send it to the
+    # notarization service
+
+    echo "Creating temp notarization archive"
+    ditto -c -k --keepParent "$APP_PATH" "notarization.zip"
+
+    # Here we send the notarization request to the Apple's Notarization service, waiting for the result.
+    # This typically takes a few seconds inside a CI environment, but it might take more depending on the App
+    # characteristics. Visit the Notarization docs for more information and strategies on how to optimize it if
+    # you're curious
+
+    echo "Notarize app"
+    xcrun notarytool submit "notarization.zip" --keychain-profile "notarytool-profile" --wait
+
+    # Finally, we need to "attach the staple" to our executable, which will allow our app to be
+    # validated by macOS even when an internet connection is not available.
+    echo "Attach staple"
+    xcrun stapler staple "$APP_PATH"
+}
+
+sign "Blades of Exile"
+sign "BoE Scenario Editor"
+sign "BoE Character Editor"
--- a/99
+++ b/99
@@ -199,13 +199,15 @@ elif platform == "win32":
 		vcpkg_other_libs = list(filter(path.exists, vcpkg_other_libs))
 		vcpkg_other_bins = [path.join(d.get_abspath(), 'bin') for d in vcpkg_other_packages]
 		vcpkg_other_bins = list(filter(path.exists, vcpkg_other_bins))
-
-		include_paths=[path.join(vcpkg_installed, 'include')] + vcpkg_other_includes
+		project_includes = []
+		for (root, dirs, files) in os.walk('src'):
+			project_includes.append(path.join(os.getcwd(), root))
+		include_paths=project_includes
 		env.Append(
-			LINKFLAGS=['/SUBSYSTEM:WINDOWS','/ENTRY:mainCRTStartup',f'/MACHINE:X{arch_short}'],
+			LINKFLAGS=['/SUBSYSTEM:WINDOWS','/ENTRY:mainCRTStartup',f'/MACHINE:X{arch_short}', '/VERBOSE', '/NODEFAULTLIB:libboost_filesystem-vc142-mt-x64-1_85.lib'],
 			CXXFLAGS=['/EHsc','/MD','/FIglobal.hpp'],
 			CPPPATH=include_paths,
-			LIBPATH=[path.join(vcpkg_installed, 'lib')] + vcpkg_other_libs + vcpkg_other_bins,
+			LIBPATH=[],
 			LIBS=Split("""
 				kernel32
 				user32
@@ -300,10 +302,6 @@ if not env.GetOption('clean'):
 		print("There's a problem with your compiler!")
 		Exit(1)

-	if not conf.CheckLib('zlib' if (platform == "win32" and 'mingw' not in env["TOOLS"]) else 'z'):
-		print('zlib must be installed!')
-		Exit(1)
-
 	def check_lib(lib, disp, suffixes=[], versions=[], msvc_versions=[]):
 		if "mingw" in env["TOOLS"] and lib.startswith("sfml"):
 			lib = "lib" + lib
@@ -338,6 +336,8 @@ if not env.GetOption('clean'):
 	boost_versions = ['-1_84'] # This is a bit of a hack. :(
 	suffixes = ['-mt', f'-mt-x{env["bits"]}']

+	zlib = 'zlib' if (platform == "win32" and 'mingw' not in env["TOOLS"]) else 'z'
+	check_lib(zlib, 'zlib', [], [])

 	check_header('boost/lexical_cast.hpp', 'Boost.LexicalCast')
 	check_header('boost/optional.hpp', 'Boost.Optional')
@@ -347,10 +347,11 @@ if not env.GetOption('clean'):
 	check_header('boost/spirit/include/classic.hpp', 'Boost.Spirit.Classic')
 	check_lib('boost_system', 'Boost.System', suffixes, boost_versions)
 	check_lib('boost_filesystem', 'Boost.Filesystem', suffixes, boost_versions)
-	check_lib('sfml-system', 'SFML-system')
-	check_lib('sfml-window', 'SFML-window')
-	check_lib('sfml-audio', 'SFML-audio')
-	check_lib('sfml-graphics', 'SFML-graphics')
+	sfml_suffixes = ['-d']
+	check_lib('sfml-system', 'SFML-system', sfml_suffixes)
+	check_lib('sfml-window', 'SFML-window', sfml_suffixes)
+	check_lib('sfml-audio', 'SFML-audio', sfml_suffixes)
+	check_lib('sfml-graphics', 'SFML-graphics', sfml_suffixes)

 	# Make sure Catch2 is cloned
 	if not path.exists('deps/Catch2/README.md'):
@@ -369,6 +370,7 @@ if not env.GetOption('clean'):
 	if platform == 'posix':
 		def check_tgui(conf, second_attempt=False):
 			if conf.CheckLib('libtgui', language='C++'):
+				bundled_libs.append('tgui')
 				return conf
 			else:
 				if second_attempt:
@@ -450,7 +452,31 @@ Export("data_dir")
 SConscript(["rsrc/SConscript", "doc/SConscript"])

 # Bundle required frameworks and libraries
-
+def handle_bundled_libs(extension, prefix=''):
+	target_dirs = ["#build/Blades of Exile", "#build/test"]
+	for lib in bundled_libs:
+		for lpath in env['LIBPATH']:
+			def check_path(src_file):
+				_dir = os.path.dirname(src_file)
+				print(f'checking {_dir} for {prefix}{lib}')
+				try:
+					print(os.listdir(_dir))
+				except:
+					pass
+				if path.exists(src_file) and src_file != "/usr/lib/x86_64-linux-gnu/libz.so":
+					for targ in target_dirs:
+						for so in os.listdir(_dir):
+							if os.path.basename(src_file) in so:
+								print(f'found {path.join(_dir, so)}')
+								env.Install(targ, path.join(_dir, so))
+						return True
+				return False
+			if check_path(path.join(lpath, prefix + lib + extension)):
+				break
+			elif check_path(path.join(lpath.replace('lib', 'bin'), prefix + lib + extension)):
+				break
+			elif check_path(path.join(lpath, 'x86_64-linux-gnu', prefix + lib + extension)):
+				break
 if platform == "darwin":
 	app_targets = []
 	if 'game' in targets:
@@ -482,20 +508,7 @@ elif platform == "win32":
 		brotlidec
 		brotlicommon
 	""")
-	target_dirs = ["#build/Blades of Exile", "#build/test"]
-	for lib in bundled_libs:
-		for lpath in env['LIBPATH']:
-			src_file = path.join(lpath, lib + ".dll")
-			if path.exists(src_file):
-				for targ in target_dirs:
-					env.Install(targ, src_file)
-				break
-			elif 'lib' in lpath:
-				src_file = path.join(lpath.replace('lib', 'bin'), lib + ".dll")
-				if path.exists(src_file):
-					for targ in target_dirs:
-						env.Install(targ, src_file)
-					break
+	handle_bundled_libs(".dll")
 	# Extra: Microsoft redistributable libraries installer
 	if 'msvc' in env["TOOLS"]:
 		if path.exists("deps/VCRedistInstall.exe"):
@@ -503,11 +516,41 @@ elif platform == "win32":
 		else:
 			print("WARNING: Cannot find installer for the MSVC redistributable libraries for your version of Visual Studio.")
 			print("Please download it from Microsoft's website and place it at:")
-			print("      deps/VCRedistInstall.exe")
+			print("	  deps/VCRedistInstall.exe")
 			# Create it so its lack doesn't cause makensis to break
 			# (Because the installer is an optional component.)
 			os.makedirs("build/Blades of Exile", exist_ok=True)
 			open("build/Blades of Exile/VCRedistInstall.exe", 'w').close()
+elif platform == "posix":
+	targets = [
+		"Blades of Exile",
+		"BoE Character Editor",
+		"BoE Scenario Editor",
+	]
+	def patchelf():
+		to_patch = targets + [so for so in os.listdir("build/Blades of Exile") if '.so' in so]
+		for targ in to_patch:
+			subprocess.call(['patchelf', '--set-rpath', '.', targ], cwd='build/Blades of Exile')
+	atexit.register(patchelf)
+	bundled_libs += Split("""
+		GL
+		X11
+		stdc++
+		Xrandr
+		Xcursor
+		udev
+		openal
+		vorbisenc
+		vorbisfile
+		vorbis
+		ogg
+		FLAC
+		freetype
+		GLdispatch
+		GLX
+		xcb
+	""")
+	handle_bundled_libs(".so", "lib")

 if env["package"]:
 	if platform == "darwin":