sambruk/excalidraw
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
* build: Add script to update readme before stable release

* fix

* fix
This commit is contained in:
Aakansha Doshi 2021-07-03 18:50:22 +05:30 committed by GitHub
parent f861a9fdd0
commit bc8ba08ad0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
scripts/updateReadme.js Normal file
View File

@ -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");

4
src/packages/excalidraw/README_NEXT.md
View File

@ -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