Merge "Upload API doc model to S3 postpublish"

GitOrigin-RevId: 8d5b1ce68e068cdf47f9fddc1731b9ee269c650e
theashishmaurya · Nov 10, 2023 · 2195c5b · 2195c5b
1 parent 897c4c0
commit 2195c5b
Show file tree

Hide file tree

Showing 16 changed files with 62 additions and 3 deletions.
diff --git a/build.mjs b/build.mjs
@@ -212,7 +212,11 @@ async function buildBundle({
  * this script multiple times for multiple entry points, which would result in
  * duplicative `tsc` runs.
  */
-function extractApi({ name, dtsRollupPath }) {
+function extractApi({ name, dtsRollupPath, docModelPath }) {
+  // Excluding non-index entry points for now since we can't handle multiple entry points.
+  // TODO: https://linear.app/plasmic/issue/PLA-10114
+  const docModelEnabled = name === "index";
+
   const extractorConfig = ExtractorConfig.prepare({
     configObject: {
       apiReport: {
@@ -224,6 +228,10 @@ function extractApi({ name, dtsRollupPath }) {
       compiler: {
         tsconfigFilePath: path.resolve("./tsconfig.json"),
       },
+      docModel: {
+        enabled: docModelEnabled,
+        apiJsonFilePath: path.resolve(`./api/temp/${name}.api.json`),
+      },
       dtsRollup: {
         enabled: true,
         untrimmedFilePath: path.resolve(dtsRollupPath),

diff --git a/packages/auth-api/package.json b/packages/auth-api/package.json
@@ -24,6 +24,7 @@
     "test": "yarn --cwd=../.. test --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/auth-react/package.json b/packages/auth-react/package.json
@@ -24,6 +24,7 @@
     "test": "yarn --cwd=../.. test",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/data-sources-context/package.json b/packages/data-sources-context/package.json
@@ -24,6 +24,7 @@
     "test": "yarn --cwd=../.. test --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/data-sources/package.json b/packages/data-sources/package.json
@@ -24,6 +24,7 @@
     "test": "yarn --cwd=../.. test --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-core/package.json b/packages/loader-core/package.json
@@ -25,6 +25,7 @@
     "test": "yarn --cwd=../.. test",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-edge/package.json b/packages/loader-edge/package.json
@@ -26,6 +26,7 @@
     "coverage": "yarn --cwd=../.. test --coverage --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-fetcher/package.json b/packages/loader-fetcher/package.json
@@ -25,6 +25,7 @@
     "test": "yarn --cwd=../.. test",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-gatsby/package.json b/packages/loader-gatsby/package.json
@@ -31,7 +31,8 @@
     "build:gatsby-node": "node ../../build.mjs src/gatsby-node.ts --no-esm",
     "build:gatsby-ssr": "node ../../build.mjs src/gatsby-ssr.ts --no-esm",
     "yalcp": "yalc publish --push",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh"
   },
   "keywords": [
     "gatsby",

diff --git a/packages/loader-nextjs/package.json b/packages/loader-nextjs/package.json
@@ -53,6 +53,7 @@
     "coverage": "yarn test --coverage",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-react/package.json b/packages/loader-react/package.json
@@ -47,6 +47,7 @@
     "coverage": "yarn --cwd=../.. test --coverage --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-splits/package.json b/packages/loader-splits/package.json
@@ -26,6 +26,7 @@
     "coverage": "yarn --cwd=../.. test --coverage --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/loader-vue/package.json b/packages/loader-vue/package.json
@@ -15,7 +15,8 @@
     "build": "yarn build:types && yarn build:index",
     "build:types": "yarn tsc",
     "build:index": "node ../../build.mjs src/index.ts",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh"
   },
   "files": [
     "dist"

diff --git a/packages/query/package.json b/packages/query/package.json
@@ -24,6 +24,7 @@
     "test": "yarn --cwd=../.. test --passWithNoTests",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/packages/watcher/package.json b/packages/watcher/package.json
@@ -25,6 +25,7 @@
     "test": "yarn --cwd=../.. test",
     "lint": "eslint",
     "prepublishOnly": "npm run build",
+    "postpublish": "bash ../../scripts/publish-api-doc-model.sh",
     "size": "size-limit",
     "analyze": "size-limit --why"
   },

diff --git a/scripts/publish-api-doc-model.sh b/scripts/publish-api-doc-model.sh
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+function read_json_object_field() {
+  file=$1
+  key=$2
+
+  # -m 1 returns only first match
+  # -o returns only matched text
+
+  # first match the sequence "<key>": "<value> (no closing quote)
+  grep -m 1 -o '"'"$key"'": "[^"]*' $file | \
+  # then match the last part without quotes
+  grep -o '[^"]*$'
+}
+
+package_name=$(read_json_object_field ./package.json name)
+package_version=$(read_json_object_field ./package.json version)
+
+# Check that the cicd.bash wasn't publishing to Verdaccio
+# NPM_REGISTRY in the start_verdaccio function
+if [ -n "$NPM_REGISTRY" ]; then
+  echo "We were probably publishing to Verdaccio because the NPM_REGISTRY flag was set to $NPM_REGISTRY. "\
+       "Not publishing API doc model for $package_name@$package_version."
+  exit 0
+fi;
+
+# Sanity check that the package has already been published to NPM
+npm_version=$(npm --no-workspaces view $package_name version | tr -d '\n')
+if [ "$npm_version" != "$package_version" ]; then
+  echo "Current latest version on NPM is $npm_version. "\
+       "Not publishing API doc model for $package_name@$package_version."
+  exit 0
+fi
+
+s3_dest="s3://api-doc-model/$package_name/$package_version"
+aws s3 sync "./api/temp" $s3_dest
+echo "Published API doc model for $package_name@$package_version to $s3_dest."