chore: minor adjustments

ci: update to checkout@v6
fix(ci): only update what's needed
fix(sync:deps): allow existing deps to udpate
fix(.npmrc): opt out of legacy deps
chore: remove sync:mods script in package.json
chore: update readme

Author: execaman

.github/workflows/sync.yml

@@ -21,15 +21,15 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           submodules: recursive
           fetch-depth: 0
 
       - name: Update submodule
-        run: npm run sync:mods
+        run: git submodule update --remote
 
-      - name: Check update
+      - name: Check status
         id: check
         run: |
           if [[ -n "$(git status --porcelain)" ]]; then
@@ -38,13 +38,13 @@ jobs:
             echo "update=false" >> $GITHUB_OUTPUT
           fi
 
-      - name: Commit update
+      - name: Commit changes
         if: steps.check.outputs.update == 'true'
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add .
-          git commit -m "chore: sync with ejs"
+          git add ejs
+          git commit -m "chore(main): sync with ejs"
           git push origin main
 
   update:
@@ -53,24 +53,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           submodules: recursive
           fetch-depth: 0
 
       - name: Setup Node
         uses: actions/setup-node@v5
 
-      - name: Sync deps
+      - name: Sync dependencies
         run: npm run sync:deps
 
-      - name: Commit deps
+      - name: Commit changes
         run: |
           if [[ -n "$(git status --porcelain)" ]]; then
             git config user.name "github-actions[bot]"
             git config user.email "github-actions[bot]@users.noreply.github.com"
-            git add .
-            git commit -m "deps: sync with ejs"
+            git add package.json
+            git commit -m "chore(deps): sync with ejs"
             git push origin main
           else
             exit 0

.gitmodules

@@ -1,3 +1,4 @@
 [submodule "ejs"]
 	path = ejs
 	url = https://github.com/yt-dlp/ejs
+  branch = main

.npmrc

@@ -1,2 +1 @@
-package-lock = false
-legacy-peer-deps = true
+package-lock = false

README.md

@@ -1,13 +1,15 @@
 ## Setup
 
 - Clone this repository
-- Run `npm run sync:mods` to bring submodules
+- Run `git config submodule.recurse true`
+- Run `git pull` to clone the ejs subdmodule
 - Run `npm install` to install all dependencies
-- Configure the service in `.env` and run `npm start`
+- Configure the service in `.env`
 
 ## Maintain
 
-- Run `npm run sync:mods` to sync with ejs
-- Run `npm run sync:deps` to bring any new dependencies from ejs
+- A workflow keeps the branch up-to-date
+- You can run `git submodule update --remote` to update manually
+- Run `npm run sync:deps` after update to sync all dependencies
 - Run `npm run build` to build and ensure changes were compatible
-- The built file would be under `lib`
+- The built files would be under `lib`

package.json

@@ -6,8 +6,7 @@
   "scripts": {
     "build": "tsup",
     "start": "node lib/index.js",
-    "sync:deps": "node scripts/deps.js",
-    "sync:mods": "git submodule update --init --remote --recursive --rebase"
+    "sync:deps": "node scripts/deps.js"
   },
   "devDependencies": {
     "@types/express": "^5.0.3",

scripts/deps.js

@@ -4,7 +4,6 @@ const src = JSON.parse(readFileSync("package.json", "utf8"));
 const ejs = JSON.parse(readFileSync("./ejs/package.json", "utf8"));
 
 for (const dep in ejs.dependencies) {
-  if (dep in src.dependencies) continue;
   src.dependencies[dep] = ejs.dependencies[dep];
 }