Merge pull request #3412 from jessicakjellin/build-script-and-github-releases

Build script for more browsers and make zipfile with github release

Author: ImprovedTube

.github/workflows/build-firefox-app.yml

@@ -0,0 +1,38 @@
+name: Create browser builds for release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install pip
+        run: python -m pip install --upgrade pip
+
+      - name: Build Firefox and Chromium variants
+        run: |
+          cd build/
+          python3 build.py -firefox
+          python3 build.py -chromium-stable
+          python3 build.py -chromium-beta
+          python3 build.py -chromium-edge
+          python3 build.py -chromium-whale
+          ls -la
+
+      - name: Upload builds to Release
+        uses: softprops/action-gh-release@v2
+        if: ${{ startsWith(github.ref, 'refs/tags/') }}
+        with:
+          files: ${{ github.workspace }}/*.zip
+          if-no-files-found: error

build/build.py

@@ -19,64 +19,92 @@
 import json
 import os
 import zipfile
+import re
 #import pathlib
-#import re
+
+#---------------------------------------------------------------
+# Helpers
+#---------------------------------------------------------------
+
+EXCLUDE_TOP_LEVEL = {
+    'tests',
+    'jest.config.js',
+    'package-lock.json',
+    'package.json',
+    'README.md',
+    'LICENSE',
+    'CONTRIBUTING.md'
+}
+
+def _sanitize_name_for_store(name, store):
+    # remove non-ASCII (simple emoji removal) and replace single quote with '*' for Edge/Whale
+    sanitized = re.sub(r'[^\x00-\x7F]+', '', name or '')
+    if store in ('edge', 'whale'):
+        sanitized = sanitized.replace("'", "*")
+    return sanitized
 
 #---------------------------------------------------------------
 # 2.0 CHROMIUM
 #---------------------------------------------------------------
 
 def chromium(browser):
-	temporary_path = '../cached'
-
-	if (os.path.isdir(temporary_path)):
-		shutil.rmtree(temporary_path, ignore_errors=True)
-
-	os.mkdir(temporary_path)
-	os.chdir(temporary_path)
-
-	for item in os.listdir('../'):
-		if (
-			item != '.git' and
-			item != '.github' and
-			item != 'cached' and
-			item != 'previews' and
-			item != 'py' and
-			item != 'wiki' and
-			item != 'LICENSE' and
-			item != 'README.md' and
-			item != 'SECURITY.md' and
-			item.find('.zip') == -1
-		):
-			s = os.path.join('../', item)
-			d = os.path.join(temporary_path, item)
-			if os.path.isdir(s):
-				shutil.copytree(s, d, True, None)
-			else:
-				shutil.copy2(s, d)
-
-	with open('manifest.json', 'r+') as json_file:
-		data = json.load(json_file)
-
-		version = data['version']
-
-		if (browser == 'beta'):
-			data['name'] = 'ImprovedTube (testing)';
-
-		json_file.seek(0)
-		json.dump(data, json_file, indent=4, sort_keys=True)
-		json_file.truncate()
-
-	archive = zipfile.ZipFile('../chromium-' + version + '.zip', 'w', zipfile.ZIP_DEFLATED)
-
-	for root, dirs, files in os.walk('.'):
-		for file in files:
-			archive.write(os.path.join(root, file),
-						  os.path.relpath(os.path.join(root, file),
-						  				  os.path.join('.', '.')))
-
-	archive.close()
-	shutil.rmtree(temporary_path)
+    temporary_path = '../cached'
+
+    if os.path.isdir(temporary_path):
+        shutil.rmtree(temporary_path, ignore_errors=True)
+
+    os.mkdir(temporary_path)
+
+    for item in os.listdir('../'):
+        if (
+            item != '.git' and
+            item != '.github' and
+            item != 'cached' and
+            item != 'previews' and
+            item != 'py' and
+            item != 'wiki' and
+            item != 'LICENSE' and
+            item != 'README.md' and
+            item != 'SECURITY.md' and
+            item.find('.zip') == -1
+        ):
+            if item in EXCLUDE_TOP_LEVEL:
+                continue
+            s = os.path.join('.', item)
+            d = os.path.join(temporary_path, item)
+            if os.path.isdir(s):
+                shutil.copytree(s, d, True, None)
+            else:
+                shutil.copy2(s, d)
+
+    os.chdir(temporary_path)
+
+    with open('manifest.json', 'r+') as json_file:
+        data = json.load(json_file)
+
+        version = data['version']
+
+        if (browser == 'beta'):
+            data['name'] = 'ImprovedTube (testing)'
+
+        if browser in ('edge', 'whale'):
+            data['name'] = _sanitize_name_for_store(data.get('name', ''), browser)
+
+        json_file.seek(0)
+        json.dump(data, json_file, indent=4, sort_keys=True)
+        json_file.truncate()
+
+    archive_name = os.path.join('..', f'chromium-{browser}-{version}.zip')
+    archive = zipfile.ZipFile(archive_name, 'w', zipfile.ZIP_DEFLATED)
+
+    for root, dirs, files in os.walk('.'):
+        for file in files:
+            archive.write(os.path.join(root, file),
+                          os.path.relpath(os.path.join(root, file),
+                          				  os.path.join('.', '.')))
+
+    archive.close()
+    shutil.rmtree(temporary_path)
 
 
 #---------------------------------------------------------------
@@ -102,9 +130,10 @@ def firefox():
             item != 'LICENSE' and
             item != 'README.md' and
             item != 'SECURITY.md' and
-            item.find('.zip') == -1 and
-            item != 'build'
+            item.find('.zip') == -1
         ):
+            if item in EXCLUDE_TOP_LEVEL:
+                continue
             s = os.path.join('.', item)
             d = os.path.join(temporary_path, item)
             if os.path.isdir(s):
@@ -154,5 +183,9 @@ def firefox():
         chromium('stable')
     elif arg == '-chromium-beta':
         chromium('beta')
+    elif arg == '-chromium-edge':
+        chromium('edge')
+    elif arg == '-chromium-whale':
+        chromium('whale')
     elif arg == '-firefox':
         firefox()