fix: integrate protocol sync into CI/CD and update documentation

.github/workflows/release.yml

@@ -51,6 +51,11 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      - name: Sync Protocol Constants
+        run: |
+          chmod +x ./scripts/sync-constants.sh
+          ./scripts/sync-constants.sh
+
       - name: Create Extension Zip
         run: |
           zip -r koala-sync-extension.zip extension/ -x "*.DS_Store*"

README.md

@@ -37,10 +37,14 @@ docker-compose up -d --build
 The server will be available at `ws://localhost:3000`.
 
 ### 2. Chrome Extension
-1. Open Chrome and go to `chrome://extensions/`.
+1. **Synchronize Protocol**: From the root directory, run the sync script to copy the master constants to the extension folder:
-2. Enable **Developer mode** (top right).
+   ```bash
-3. Click **Load unpacked**.
+   ./scripts/sync-constants.sh
-4. Select the `extension/` folder.
+   ```
+2. Open Chrome and go to `chrome://extensions/`.
+3. Enable **Developer mode** (top right).
+4. Click **Load unpacked**.
+5. Select the `extension/` folder.
 
 ## Usage
 1. Open the extension and go to the **Settings** tab to set your **Username**.

SYNC_GUIDE.md

@@ -7,10 +7,11 @@ To ensure that the extension and the relay server are always using the exact sam
 
 ## When should you run the sync script?
 You MUST run the synchronization script in any of the following scenarios:
-1. **After modifying** `shared/constants.js`.
+1. **After a fresh `git clone` or `git pull`** (as the synced files are ignored by git).
-2. **After modifying** `shared/blacklist.js`.
+2. **After modifying** `shared/constants.js`.
-3. **Before committing** changes to the repository if any protocol-related files were touched.
+3. **After modifying** `shared/blacklist.js`.
-4. **Before deploying** the server or releasing the extension.
+4. **Before committing** changes to the repository if any protocol-related files were touched.
+5. **Before deploying** the server or releasing the extension.
 
 ## How to sync
 

extension/README.md

@@ -22,9 +22,10 @@ KoalaSync requires `<all_urls>` permission to detect and interact with video ele
 - **Zero Telemetry**: No analytics or external tracking scripts.
 
 ## Installation
-1. Open Chrome and go to `chrome://extensions/`.
+1. **Sync Protocol**: Run `./scripts/sync-constants.sh` (macOS/Linux) or `scripts\sync-constants.bat` (Windows) from the root.
-2. Enable **Developer mode** (top right).
+2. Open Chrome and go to `chrome://extensions/`.
-3. Click **Load unpacked** and select the `extension` folder from this repository.
+3. Enable **Developer mode** (top right).
+4. Click **Load unpacked** and select the `extension` folder.
 
 ## Development
 If you modify `shared/constants.js`, you must synchronize the changes across the extension and server:

shared/constants.js

@@ -3,7 +3,7 @@
  */
 
 export const PROTOCOL_VERSION = "1.0.0";
-export const APP_VERSION = "1.0.0";
+export const APP_VERSION = "1.0.3";
 
 export const OFFICIAL_SERVER_URL = 'wss://sync.shik3i.net';
 export const OFFICIAL_LANDING_PAGE_URL = 'https://koalasync.shik3i.net';