add ci action to publish description changes to modrinth

Author: apehum

.github/workflows/descriptions.yml

@@ -0,0 +1,50 @@
+name: Platform descriptions
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - .vitepress/data/addons.ts
+      - .vitepress/data/project.ts
+      - parts/description.md
+      - scripts/platform.ts
+      - scripts/publish-modrinth.ts
+      - .github/workflows/descriptions.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  descriptions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate descriptions
+        run: |
+          npm run -s platform modrinth > modrinth.md
+          npm run -s platform curseforge > curseforge.md
+
+      # curseforge has no write API, so its description is uploaded for manual pasting
+      - name: Upload descriptions
+        uses: actions/upload-artifact@v4
+        with:
+          name: descriptions
+          path: |
+            modrinth.md
+            curseforge.md
+
+      - name: Update Modrinth
+        env:
+          MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
+        run: npm run -s publish:modrinth

.vitepress/data/project.ts

@@ -3,6 +3,9 @@ export interface NavLink {
   url: string
 }
 
+// modrinth project slug, used to sync the description over the API
+export const modrinthProject = 'plasmo-voice'
+
 // wide banner for platform descriptions; the docs site uses /logo512.png instead
 export const logo = 'https://imgur.com/3ccgCRz.png'
 

package.json

@@ -4,7 +4,8 @@
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",
     "docs:preview": "vitepress preview",
-    "platform": "node --disable-warning=ExperimentalWarning --experimental-strip-types scripts/platform.ts"
+    "platform": "node --disable-warning=ExperimentalWarning --experimental-strip-types scripts/platform.ts",
+    "publish:modrinth": "node --disable-warning=ExperimentalWarning --experimental-strip-types scripts/publish-modrinth.ts"
   },
   "devDependencies": {
     "@types/node": "^26.1.1",

scripts/publish-modrinth.ts

@@ -0,0 +1,50 @@
+import { modrinthProject } from '../.vitepress/data/project.ts'
+import { renderPage } from './platform.ts'
+
+const API = 'https://api.modrinth.com/v2'
+const USER_AGENT = 'plasmoapp/pv-docs (description sync)'
+
+const dryRun = process.argv.includes('--dry-run')
+
+const token = process.env.MODRINTH_TOKEN
+if (!token && !dryRun) {
+  console.error('MODRINTH_TOKEN is not set')
+  process.exit(1)
+}
+
+const body = renderPage('modrinth')
+
+const current = await fetch(`${API}/project/${modrinthProject}`, {
+  headers: { 'User-Agent': USER_AGENT },
+})
+if (!current.ok) {
+  console.error(`failed to fetch project: ${current.status} ${await current.text()}`)
+  process.exit(1)
+}
+
+if ((await current.json()).body.trim() === body.trim()) {
+  console.log('Modrinth description already up to date, nothing to do')
+  process.exit(0)
+}
+
+if (dryRun) {
+  console.log('Modrinth description differs, would update (dry run)')
+  process.exit(0)
+}
+
+const res = await fetch(`${API}/project/${modrinthProject}`, {
+  method: 'PATCH',
+  headers: {
+    Authorization: token!,
+    'Content-Type': 'application/json',
+    'User-Agent': USER_AGENT,
+  },
+  body: JSON.stringify({ body }),
+})
+
+if (!res.ok) {
+  console.error(`failed to update project: ${res.status} ${await res.text()}`)
+  process.exit(1)
+}
+
+console.log('Modrinth description updated')