@krx3d/tizentubekrx 1.15.17 → 1.15.20

package/.github/workflows/publish-on-release.yml

@@ -1,13 +1,74 @@
-name: Build & Publish (mods + service)
+# -----------------------------------------------------------------------------
+# Build and publish TizenTubeKrX to npm
+#
+# WHAT THIS WORKFLOW DOES
+# -----------------------
+# - Runs on every push to the `main` branch (build + verification)
+# - Runs again when a GitHub Release is published (build + npm publish)
+# - Builds:
+#     - dist/userScript.js  (browser userscript, bundled & minified)
+#     - dist/service.js     (DIAL service, bundled with Rollup)
+# - Publishes the package to https://www.npmjs.com on release only
+#
+# WHEN IT RUNS
+# ------------
+# push to main:
+#   - Builds the project
+#   - Does NOT publish to npm
+#
+# release (published):
+#   - Builds the project
+#   - Publishes to npm
+#
+# PREREQUISITES (REQUIRED)
+# -----------------------
+# 1) Create an npm account:
+#    https://www.npmjs.com/signup
+#
+# 2) Create an npm access token:
+#    - npm → Profile → Access Tokens
+#    - Click "Generate New Token"
+#    - Token name: anything you want
+#    - CHECK: "Bypass two-factor authentication (2FA)"
+#    - Packages and scopes:
+#        - Permissions: Read and Write
+#        - Scope: All packages
+#    - Expiration date: e.g. 90 days
+#    - Click "Generate token" and COPY it
+#
+# 3) Add the token to GitHub Secrets:
+#    - GitHub repository → Settings
+#    - Security → Secrets and variables → Actions
+#    - Repository secrets → New repository secret
+#        Name:   NPM_TOKEN
+#        Secret: <paste npm token here>
+#
+# PACKAGE REQUIREMENTS
+# --------------------
+# - package.json must contain a unique name, e.g.:
+#     "@krx3d/tizentubekrx"
+# - The version MUST be increased before each release
+#   (npm will reject duplicate versions)
+#
+# HOW TO PUBLISH A NEW VERSION
+# ----------------------------
+# 1) Bump "version" in package.json
+# 2) Commit and push to `main`
+# 3) Create a GitHub Release
+# 4) When the release is published:
+#      → GitHub Actions builds
+#      → npm publish runs automatically
+#
+# -----------------------------------------------------------------------------
+
+name: Build and publish on release
 
 on:
   push:
     branches:
       - main
-
-permissions:
-  contents: read
-  packages: write
+  release:
+    types: [published]
 
 jobs:
   build-and-publish:
@@ -21,123 +82,52 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          registry-url: 'https://registry.npmjs.org/'
-
-      - name: Show repository structure
-        run: |
-          echo "=== ROOT ==="
-          ls -la
-          echo "=== mods ==="
-          [ -d mods ] && ls -la mods || echo "mods/ not present"
-          echo "=== service ==="
-          [ -d service ] && ls -la service || echo "service/ not present"
+          registry-url: https://registry.npmjs.org/
 
-      # -----------------------------
-      # Build MODS (Rollup – upstream)
-      # -----------------------------
+      # ----------------------------
+      # Build mods (userScript.js)
+      # ----------------------------
       - name: Install mods dependencies
         run: |
           set -euo pipefail
-          if [ -f mods/package.json ]; then
-            echo "Installing mods dependencies"
-            if [ -f mods/package-lock.json ]; then
-              npm ci --prefix mods
-            else
-              npm install --prefix mods
-            fi
-          else
-            echo "No mods/package.json, skipping mods install"
-          fi
+          cd mods
+          npm ci
 
       - name: Build mods (rollup)
         run: |
           set -euo pipefail
-          if [ -f mods/package.json ]; then
-            echo "Running mods build"
-            npm run build --prefix mods
-          else
-            echo "Skipping mods build"
-          fi
-
-      - name: Verify dist/userScript.js
-        run: |
-          set -euo pipefail
-          if [ ! -f dist/userScript.js ]; then
-            echo "::error::dist/userScript.js not generated"
-            exit 1
-          fi
-          echo "dist/userScript.js:"
-          ls -lh dist/userScript.js
+          cd mods
+          npx rollup -c
 
-      # -----------------------------
-      # Build SERVICE (ncc bundle)
-      # -----------------------------
+      # ----------------------------
+      # Build service (service.js)
+      # ----------------------------
       - name: Install service dependencies
         run: |
           set -euo pipefail
-          if [ -f service/package.json ]; then
-            echo "Installing service dependencies"
-            if [ -f service/package-lock.json ]; then
-              npm ci --prefix service
-            else
-              npm install --prefix service
-            fi
-          else
-            echo "No service/package.json, skipping service install"
-          fi
+          cd service
+          npm ci
 
-      - name: Detect service entry
-        id: service_entry
+      - name: Build service (rollup)
         run: |
           set -euo pipefail
+          cd service
+          npx rollup -c
 
-          ENTRY=""
-
-          if [ -f service/package.json ]; then
-            MAIN=$(node -e "console.log(require('./service/package.json').main || '')")
-            if [ -n "$MAIN" ]; then
-              if [[ "$MAIN" == */* ]]; then
-                ENTRY="$MAIN"
-              else
-                ENTRY="service/$MAIN"
-              fi
-            fi
-          fi
-
-          if [ -z "$ENTRY" ]; then
-            for f in service.js index.js app.js server.js; do
-              if [ -f "service/$f" ]; then
-                ENTRY="service/$f"
-                break
-              fi
-            done
-          fi
-
-          if [ -n "$ENTRY" ]; then
-            echo "entry=$ENTRY" >> "$GITHUB_OUTPUT"
-            echo "Service entry: $ENTRY"
-          else
-            echo "entry=" >> "$GITHUB_OUTPUT"
-            echo "No service entry found"
-          fi
-
-      - name: Bundle service with ncc
-        if: steps.service_entry.outputs.entry != ''
+      # ----------------------------
+      # Verify output
+      # ----------------------------
+      - name: Verify dist output
         run: |
           set -euo pipefail
-          mkdir -p dist
-          npx @vercel/ncc build "${{ steps.service_entry.outputs.entry }}" -o dist_tmp
-          mv dist_tmp/index.js dist/service.js
-          rm -rf dist_tmp
-          echo "dist/service.js:"
-          ls -lh dist/service.js
+          ls -lh dist
+          test -f dist/userScript.js
+          test -f dist/service.js
 
-      # -----------------------------
+      # ----------------------------
       # Publish to npm
-      # -----------------------------
-      - name: Publish to npm
+      # ----------------------------
+      - name: Publish package
+        run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: |
-          set -euo pipefail
-          npm publish --access public

package/README.md

@@ -12,7 +12,7 @@ Looking for an app for Android TVs? Check out [TizenTube Cobalt](https://github.
 
 1. Install TizenBrew from [here](https://github.com/reisxd/TizenBrew) and follow the instructions.
 
-2. TizenTube is installed to TizenBrew by default. It should be in the home screen. If not, add `@foxreis/tizentube` as a NPM module in TizenBrew module manager.
+2. TizenTube is installed to TizenBrew by default. It should be in the home screen. If not, add `@krx3d/tizentubekrx` as a NPM module in TizenBrew module manager.
 
 # Features