ci: typedoc website

.github/workflows/docs.yml

@@ -25,22 +25,23 @@ jobs:
         run: pnpm install --frozen-lockfile
 
       - name: Checkout docs branch
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          ref: "docs"
+          ref: "distubejs/distubejs.github.io"
           path: "docs"
+          token: ${{ secrets.DISTUBE_TOKEN }}
+
+      - name: Delete old docs
+        run: rm -rf docs
 
       - name: Generate documentation
         run: pnpm run docs
 
-      - name: Move generated docs file
-        run: mv docs.json docs/${{ github.ref_name }}.json
-
       - name: Commit and push
         run: |
           cd docs
-          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
+          git config --local user.email github-actions@github.com
+          git config --local user.name github-actions
           git add .
           git commit -m "Docs build for ${{ github.ref_type }} ${{ github.ref_name }}: ${{ github.sha }}"
           git push

.github/workflows/publish.yml

@@ -6,6 +6,8 @@ jobs:
   publish:
     name: Build & Publish
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -21,12 +23,9 @@ jobs:
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
-      # - name: Change version to ${{ github.event.release.tag_name }}
-      #   run: pnpm version ${{ github.event.release.tag_name }}
-
       - name: Publish
         run: |
-          pnpm publish --access public
+          pnpm publish --provenance --access public
           pnpm deprecate distube@"< ${{ github.event.release.tag_name }}" "This version is deprecated, please upgrade to the latest version."
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

README.md

@@ -26,29 +26,23 @@ A Discord.js module to simplify your music commands and play songs with audio fi
 
 ## Features
 
-- Based on `@discordjs/voice`
 - Easy to use and customize
 - Support YouTube and audio link
 - Audio filters (bassboost, nightcore, vaporwave,...)
-- Autoplay related songs
-- Plugin system to support more sites ([Plugin List](https://distube.js.org/#/docs/DisTube/stable/plugin/list))
+- Auto-play related songs
+- Plugin system to support more sites ([Plugin List](https://github.com/skick1234/DisTube/wiki/Projects-Hub#plugins))
 
 ## Requirement
 
-- Node.js 16.9.0 or higher
+- Node.js 18.17.0 or higher
 - [discord.js](https://discord.js.org) v14
 - [@discordjs/voice](https://github.com/discordjs/voice)
 - [FFmpeg](https://www.ffmpeg.org/download.html)
 - [@discordjs/opus](https://github.com/discordjs/opus)
-- [sodium-native](https://www.npmjs.com/package/sodium-native) or [sodium](https://www.npmjs.com/package/sodium)
+- [sodium-native](https://www.npmjs.com/package/sodium-native)
 
 ## Documentation
 
-Read DisTube's definitions, properties and events details in the [Documentation page](https://distube.js.org/).
+Read DisTube's definitions, properties and events details in the [API Documentation page](https://distube.js.org/).
 
-Learn how to build a music bot from scratch with [DisTube Guide](https://distube.js.org/guide)
-
-## Example Bot
-
-- [DisTube Bot](https://skick.xyz/DisTube) - A music bot with reaction controller, filters, DJ mode, user's custom playlist and voting.
-- [DisTube Example](https://github.com/distubejs/example) - Example bot with simple command handler.
+Learn how to build a music bot from scratch with [DisTube Guide](https://github.com/skick1234/DisTube/wiki)

package.json

@@ -21,7 +21,7 @@
     "build": "tsup",
     "build:check": "tsc --noEmit",
     "update": "pnpm up -L",
-    "postinstall": "husky install",
+    "postinstall": "husky",
     "prepublishOnly": "pnpm run lint && pnpm run test",
     "prepack": "pnpm run build && pinst --disable",
     "postpack": "pinst --enable",
@@ -109,6 +109,6 @@
     ]
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=18.17"
   }
 }