Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

build: Add script to update readme before stable release (#3781)

Aakansha Doshibc8ba08ad036
diff --git a/scripts/updateReadme.js b/scripts/updateReadme.js
new file mode 100644
index 0000000000..1c923b211b
--- /dev/null
+++ b/scripts/updateReadme.js
@@ -0,0 +1,23 @@
+const fs = require("fs");
+
+const excalidrawDir = `${__dirname}/../src/packages/excalidraw`;
+let data = fs.readFileSync(`${excalidrawDir}/README_NEXT.md`, "utf8");
+
+// remove note for unstable release
+data = data.replace(
+ /<!-- unstable-readme-start-->[\s\S]*?<!-- unstable-readme-end-->/,
+ "",
+);
+
+// replace "excalidraw-next" with "excalidraw"
+data = data.replace(/excalidraw-next/g, "excalidraw");
+data = data.trim();
+
+const demoIndex = data.indexOf("### Demo");
+const excalidrawNextNote =
+ "#### Note\n\n**If you don't want to wait for the next stable release and try out the unreleased changes you can use [@excalidraw/excalidraw-next](https://www.npmjs.com/package/@excalidraw/excalidraw-next).**\n\n";
+// Add excalidraw next note to try out for unreleased changes
+data = data.slice(0, demoIndex) + excalidrawNextNote + data.slice(demoIndex);
+
+// update readme
+fs.writeFileSync(`${excalidrawDir}/README.md`, data, "utf8");
diff --git a/src/packages/excalidraw/README_NEXT.md b/src/packages/excalidraw/README_NEXT.md
index 1cb4d85229..047eb5e2d7 100644
--- a/src/packages/excalidraw/README_NEXT.md
+++ b/src/packages/excalidraw/README_NEXT.md
@@ -1,4 +1,4 @@
-<!-- stable-readme-start-->
+<!-- unstable-readme-start-->
## Note
@@ -6,7 +6,7 @@
For stable release please use [@excalidraw/excalidraw](https://www.npmjs.com/package/@excalidraw/excalidraw).
-<!-- stable-readme-end-->
+<!-- unstable-readme-end-->
### Excalidraw