Slackbot:release (#1875)

* initial port to cli

* mv release-bot to subdir

* Updates error logging

* creates getRootPackageJson

* adds slackbot tests

* fix lint

* rm commander

* bot support for other repos. adds tests

* fix lint

* add slackbot as dep to cli

* Update index.ts

* Update index.ts

* Update index.ts

* fix package versions

* Use fs-extra

* export isValidJSON from meta

* Fixes slackbot tests

Author: TheSonOfThomp

.changeset/serious-buttons-compete.md

@@ -0,0 +1,5 @@
+---
+'@lg-tools/meta': patch
+---
+
+Exports `isValidJSON` utility

package.json

@@ -24,7 +24,7 @@
     "lint": "lg lint",
     "prepublishOnly": "yarn build",
     "publish": "yarn changeset publish --public",
-    "slackbot": "lg slackbot",
+    "slackbot": "lg slackbot release",
     "start": "storybook dev -p 9001 --no-version-updates",
     "test": "lg test",
     "unlink": "lg unlink",

tools/cli/package.json

@@ -21,6 +21,7 @@
     "@lg-tools/install": "0.1.2",
     "@lg-tools/link": "0.1.2",
     "@lg-tools/lint": "0.1.3",
+    "@lg-tools/slackbot": "0.1.1",
     "@lg-tools/test": "0.2.2",
     "@lg-tools/update": "0.1.2",
     "@lg-tools/validate": "0.1.2",

tools/cli/src/index.ts

@@ -3,6 +3,7 @@ import { createPackage } from '@lg-tools/create';
 import { installLeafyGreen } from '@lg-tools/install';
 import { linkPackages, unlinkPackages } from '@lg-tools/link';
 import { lint } from '@lg-tools/lint';
+import { releaseBot } from '@lg-tools/slackbot';
 import { test } from '@lg-tools/test';
 import { update } from '@lg-tools/update';
 import { validate } from '@lg-tools/validate';
@@ -67,6 +68,37 @@ cli
   .option('--scope <name>', 'The NPM organization')
   .action(unlinkPackages);
 
+/** Slackbot */
+const slackbotCmd = cli.command('slackbot');
+
+/**
+ * This command is run by GitHub Actions immediately after \`changeset\`.
+ *
+ * Must have the \`.env\` variable "SLACK_BOT_TOKEN" set.
+ * This is the "Bot User OAuth Token" found at https://api.slack.com/apps/A02H2UGAMDM/oauth, and should start with "xoxb-"
+ *
+ * To run this automatically, pass in an array of updates (in the format output by \`changeset\`) as the first argument.
+ * i.e. \`yarn slackbot '[{"name": "@leafygreen-ui/sample", "version": "0.1.0"}]' \`
+ *
+ * Optionally pass in a channel name (defaults to 'leafygreen-ui-releases').
+ * Valid channels are: \`${Object.keys(Channels).join('`, `')}\`.
+ */
+slackbotCmd
+  .command('release')
+  .arguments('[updates]')
+  .description(
+    'Notifies the MongoDB leafygreen-ui releases channel of any new packages.',
+  )
+  .option('-t, --test', 'Post to `design-system-testing`', false)
+  .option('-d, --dry', 'Dry run. Does not post', false)
+  .option('-v --verbose', 'Prints additional information to the console', false)
+  .option(
+    '-c, --channel <channel>',
+    'Channel to post to.',
+    'leafygreen-ui-releases',
+  )
+  .action(releaseBot);
+
 /** Lint */
 cli
   .command('lint')

tools/cli/tsconfig.json

@@ -26,6 +26,9 @@
     {
       "path": "../lint"
     },
+    {
+      "path": "../slackbot"
+    },
     {
       "path": "../test"
     },

tools/meta/src/getRootPackageJson.ts

@@ -0,0 +1,23 @@
+import fse from 'fs-extra';
+import path from 'path';
+
+export function getRootPackageJson(): Record<string, any> | undefined {
+  const rootDir = process.cwd();
+  const pkgJsonPath = path.resolve(rootDir, 'package.json');
+  const pkgJsonStr = fse.readFileSync(pkgJsonPath, 'utf-8');
+
+  if (isValidJSON(pkgJsonStr)) {
+    return JSON.parse(pkgJsonStr);
+  }
+}
+
+export function isValidJSON(str?: string): boolean {
+  if (!str) return false;
+
+  try {
+    JSON.parse(str);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}

tools/meta/src/index.ts

@@ -2,3 +2,4 @@ export { getAllPackageNames, getAllPackages } from './getAllPackages';
 export { getLGConfig, type LGConfig } from './getLGConfig';
 export { getPackageManager } from './getPackageManager';
 export { getPackageName } from './getPackageName';
+export { getRootPackageJson, isValidJSON } from './getRootPackageJson';

tools/slackbot/README.md

@@ -6,6 +6,8 @@
   "bin": {
     "lg-slackbot": "./bin/slackbot.js"
   },
+  "main": "dist/index.js",
+  "module": "dist/esm/index.js",
   "scripts": {
     "build": "lg-internal-build-package",
     "tsc": "tsc --build tsconfig.json"
@@ -15,10 +17,10 @@
   },
   "dependencies": {
     "@lg-tools/build": "^0.2.0",
-    "@slack/web-api": "^6.4.0",
-    "chalk": "^4.1.2",
-    "commander": "^11.0.0",
-    "lodash": "^4.17.21",
-    "node-fetch": "^2.6.1"
+    "@lg-tools/meta": "^0.1.2",
+    "@slack/web-api": "6.7.1",
+    "chalk": "4.1.2",
+    "lodash": "4.17.21",
+    "node-fetch": "2.6.11"
   }
 }

tools/slackbot/package.json

@@ -1 +1 @@
-import './slackbot';
+export { Channels, releaseBot } from './release-bot';