chore: only push readme to remote

Author: smeijer

.github/sync.yml

@@ -1,3 +1,5 @@
 magicbell/magicbell:
   - source: docs-dist
-    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-user-client
+    dest: src/go/app/site/docs/mdx/03-libraries/magicbell-swift-user-client
+    deleteOrphaned: true
+

.github/workflows/sync-docs.yml

@@ -0,0 +1,37 @@
+name: Sync Docs
+on:
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.BELLA_ACTION_TOKEN }}
+
+      - name: Configure Git
+        run: |
+          git config --global user.email '${{ secrets.BELLA_EMAIL_ADDRESS }}'
+          git config --global user.name 'MagicBella'
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: bahmutov/npm-install@v1
+
+      - name: Build docs
+        run: |
+          yarn --cwd ./packages/codegen build # needed by scripts below
+          yarn --cwd ./packages/project-client build:docs
+          yarn --cwd ./packages/user-client build:docs
+
+      - name: Push docs to remote repo
+        uses: BetaHuhn/repo-file-sync-action@v1
+        with:
+          GH_PAT: ${{ secrets.BELLA_ACTION_TOKEN }}
+          COMMIT_PREFIX: 'docs: '
+          GIT_USERNAME: 'MagicBella'
+          GIT_EMAIL: '${{ secrets.BELLA_EMAIL_ADDRESS }}'

package.json

@@ -15,6 +15,7 @@
     "@types/node": "^22.10.2",
     "glob": "^11.0.0",
     "replace-in-file": "^8.2.0",
-    "tsx": "^4.19.2"
+    "tsx": "^4.19.2",
+    "url-join": "^5.0.0"
   }
 }

scripts/docs.ts

@@ -1,36 +1,34 @@
+#! /usr/bin/env node --experimental-strip-types
 import fs from "node:fs/promises";
 import path from "node:path";
 
-import { exists, getDirs } from "@magicbell/codegen/fs";
 import * as md from "@magicbell/codegen/markdown";
 import * as glob from "glob";
+import urlJoin from 'url-join';
 
 function pascalToHyphenCase(str: string): string {
   return str.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
 }
 
-function rewriteHref(url: string) {
-  if (!url.endsWith(".md")) return url;
-  return url
-    .replace(/^documentation\//, "")
-    .replace(/([^/]+)\.md$/, (_, fileName) => pascalToHyphenCase(fileName));
-}
-
 const root = process.cwd();
 const outdir = path.join(root, "docs-dist");
 await fs.rm(outdir, { recursive: true, force: true });
 
 const pkg = JSON.parse(await fs.readFile("package.json", "utf-8"));
+const repoUrl = 'https://github.com/magicbell/magicbell-swift-user-client/blob/main'
+function rewriteHref(url: string) {
+  if (url.startsWith('http://') || url.startsWith('https://')) return url;
+  console.log('join', repoUrl, url);
+  return urlJoin(repoUrl, 'documentation', url);
+}
 
-// process readmes
+// process readme
 const [readme] = glob.sync("README.md", { cwd: root });
 const rootIndexAst = await md.read(path.join(root, readme));
 md.removeAllBeforeHeading(rootIndexAst, "Setup & Configuration");
 
-const [reference] = glob.sync("**/README.md", {
-  cwd: path.join(root, "documentation"),
-});
-const referenceAst = await md.read(path.join(root, "documentation", reference));
+const [reference] = glob.sync("documentation/**/README.md", { cwd: root });
+const referenceAst = await md.read(path.join(root, reference));
 md.reIndentHeadings(referenceAst, 2);
 // append references to root index
 rootIndexAst.children = rootIndexAst.children.concat(referenceAst.children);
@@ -39,40 +37,3 @@ md.reIndentHeadings(rootIndexAst, 1);
 md.mapLinks(rootIndexAst, rewriteHref);
 md.insertFrontMatter(rootIndexAst, { title: pkg.name });
 await md.write(rootIndexAst, path.join(outdir, "index.mdx"));
-
-// process pages
-const docs = glob.sync("**/*.md", {
-  cwd: path.join(root, "documentation"),
-});
-
-for (const file of docs) {
-  if (file === "README.md") continue;
-  const ast = await md.read(path.join(root, "documentation", file));
-
-  md.reIndentHeadings(ast, 1);
-  md.mapLinks(ast, rewriteHref);
-
-  let titleComponents = path.parse(file).name.split(".");
-  // Removing noisy namespaces
-  if (titleComponents.length > 1 && titleComponents[0] === "Components") {
-    titleComponents.shift();
-  }
-  if (titleComponents.length > 1 && titleComponents[0] === "Schemas") {
-    titleComponents.shift();
-  }
-  if (titleComponents.length > 1 && titleComponents[0] === "Operations") {
-    titleComponents.shift();
-  }
-  md.insertFrontMatter(ast, { title: titleComponents.join(".") });
-  md.removeFirstHeading(ast);
-
-  await md.write(ast, path.join(outdir, pascalToHyphenCase(file) + "x"));
-}
-
-for (const dir of getDirs(docs)) {
-  const file = path.join(outdir, dir, "index.mdx");
-  if (await exists(file)) continue;
-  const ast: md.Root = { type: "root", children: [] };
-  md.insertFrontMatter(ast, { title: path.basename(dir) });
-  await md.write(ast, pascalToHyphenCase(file));
-}

yarn.lock

@@ -2326,6 +2326,11 @@ uri-js@^4.2.2:
   dependencies:
     punycode "^2.1.0"
 
+url-join@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/url-join/-/url-join-5.0.0.tgz#c2f1e5cbd95fa91082a93b58a1f42fecb4bdbcf1"
+  integrity sha512-n2huDr9h9yzd6exQVnH/jU5mr+Pfx08LRXXZhkLLetAMESRj+anQsTAh940iMrIetKAmry9coFuZQ2jY8/p3WA==
+
 validate.io-array@^1.0.3:
   version "1.0.6"
   resolved "https://registry.yarnpkg.com/validate.io-array/-/validate.io-array-1.0.6.tgz#5b5a2cafd8f8b85abb2f886ba153f2d93a27774d"