Browse Source

fix: add readme back to npm package which was mistakenly removed (#6484)

* fix: remove update readme script from release

* update docs

* remove

* fix
Aakansha Doshi 2 years ago
parent
commit
89304c9f66
2 changed files with 6 additions and 20 deletions
  1. 0 20
      scripts/release.js
  2. 6 0
      src/packages/excalidraw/CHANGELOG.md

+ 0 - 20
scripts/release.js

@@ -1,22 +1,9 @@
-const fs = require("fs");
 const { execSync } = require("child_process");
 const { execSync } = require("child_process");
 
 
 const excalidrawDir = `${__dirname}/../src/packages/excalidraw`;
 const excalidrawDir = `${__dirname}/../src/packages/excalidraw`;
 const excalidrawPackage = `${excalidrawDir}/package.json`;
 const excalidrawPackage = `${excalidrawDir}/package.json`;
 const pkg = require(excalidrawPackage);
 const pkg = require(excalidrawPackage);
 
 
-const originalReadMe = fs.readFileSync(`${excalidrawDir}/README.md`, "utf8");
-
-const updateReadme = () => {
-  const excalidrawIndex = originalReadMe.indexOf("### Excalidraw");
-
-  // remove note for stable readme
-  const data = originalReadMe.slice(excalidrawIndex);
-
-  // update readme
-  fs.writeFileSync(`${excalidrawDir}/README.md`, data, "utf8");
-};
-
 const publish = () => {
 const publish = () => {
   try {
   try {
     execSync(`yarn  --frozen-lockfile`);
     execSync(`yarn  --frozen-lockfile`);
@@ -30,15 +17,8 @@ const publish = () => {
 };
 };
 
 
 const release = () => {
 const release = () => {
-  updateReadme();
-  console.info("Note for stable readme removed");
-
   publish();
   publish();
   console.info(`Published ${pkg.version}!`);
   console.info(`Published ${pkg.version}!`);
-
-  // revert readme after release
-  fs.writeFileSync(`${excalidrawDir}/README.md`, originalReadMe, "utf8");
-  console.info("Readme reverted");
 };
 };
 
 
 release();
 release();

+ 6 - 0
src/packages/excalidraw/CHANGELOG.md

@@ -11,6 +11,12 @@ The change should be grouped under one of the below section and must contain PR
 Please add the latest change on the top under the correct section.
 Please add the latest change on the top under the correct section.
 -->
 -->
 
 
+## Unreleased
+
+### Docs
+
+- Add the readme back to the package which was mistakenly removed [#6484](https://github.com/excalidraw/excalidraw/pull/6484)
+
 ## 0.15.0 (2023-04-18)
 ## 0.15.0 (2023-04-18)
 
 
 ### Features
 ### Features