@atlaskit/dependency-version-analytics 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/dependency-version-analytics
 
+## 1.2.0
+
+### Minor Changes
+
+- [`b734af05daf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b734af05daf) - Added support for non-ak scoped packages
+
 ## 1.1.0
 
 ### Minor Changes

package/README.md

@@ -26,7 +26,7 @@ $ atlaskit-version-analytics populate-product jira
 
 #### Description
 
-Reads the git history of changes to package.json in the current branch (assumed to be master) since the tool was last run, tracks changes to atlaskit dependencies and sends analytics in the format specified by http://go.atlassian.com/dataportal/analytics/registry/17058.
+Reads the git history of changes to package.json in the current branch (assumed to be master) since the tool was last run, tracks changes to dependencies and sends analytics in the format specified by http://go.atlassian.com/dataportal/analytics/registry/17058.
 
 This command is intended to be used in product CI pipelines to record dep changes over time.
 
@@ -34,9 +34,11 @@ Dependency versions are compared to the versions when the tool was last run, whi
 
 For initial publishing of historical events, the `--reset` flag can be used to send changes that have occurred since the start of history.
 
+For supported package scopes [refer](./src/commands/populate-historic-data/util/allowed-scopes.ts)
+
 ### populate-package \<package>
 
-Sends analytics events for published versions of the specified atlaskit package.
+Sends analytics events for published versions of the specified package.
 
 Run `yarn dependency-version-analytics --help` for more info.
 
@@ -50,7 +52,7 @@ $ atlaskit-version-analytics populate-package @atlaskit/button
 
 Reads the version history of the package from npm and sends events for versions published since the time specified by `--since`, or all versions if not specified.
 
-This command will be used to record when atlaskit publish new versions of their packages in this repo https://bitbucket.org/atlassian/atlaskit-version-analytics.
+This command will be used to record when new versions of the supported packages are published in this repo https://bitbucket.org/atlassian/atlaskit-version-analytics.
 
 ## Local development
 

package/dist/cjs/cli.js

@@ -5,17 +5,49 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.run = run;
-var _toArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toArray"));
 var _chalk = _interopRequireDefault(require("chalk"));
 var _meow = _interopRequireDefault(require("meow"));
 var _populateHistoricData = require("./commands/populate-historic-data");
 /// <reference lib="es2017.object" />
 
 // prettier-ignore
-var HELP_MSG = "\n".concat(_chalk.default.green('Global options'), "\n     ").concat(_chalk.default.yellow('--dev'), "            Send analytics to dev analytics pipeline instead of prod\n     ").concat(_chalk.default.yellow('--dryRun'), "         Performs a dry run, prints analytics events to console in JSON format instead of sending them\n     ").concat(_chalk.default.yellow('--limit'), "          Limit the number of events sent, used for validation purposes\n     ").concat(_chalk.default.yellow('--no-interactive'), " Disable any interactive prompts\n\n").concat(_chalk.default.yellow.bold('[populate-product] <product>'), "\n   Sends analytics events for atlaskit dependency versions changes in package.json.\n\n   Detects changes since the last time the tool was run by storing the last run in either statlas (--statlas flag) or using the\n   'atlaskit-dependency-version-analytics-last-run' git tag.\n   If running the tool for the first time (last run does not exist), --reset must be used to detect changes since the beginning of the repo.\n\n   ").concat(_chalk.default.green('Options'), "\n     ").concat(_chalk.default.yellow('--csv'), "         Prints AK dependency history in CSV format\n     ").concat(_chalk.default.yellow('--reset'), "       Reset change detection to detect changes from the beginning of time\n     ").concat(_chalk.default.yellow('--tag'), "         Specify a different tag to mark when the tool was last run\n     ").concat(_chalk.default.yellow('--statlas'), "     Use statlas rather than git tags for storing and sourcing last run info\n\n   ").concat(_chalk.default.green('Examples'), "\n     ").concat(_chalk.default.dim('$ atlaskit-version-analytics populate-product jira'), "\n\n").concat(_chalk.default.yellow.bold('[populate-package] <package>'), "\n   Sends analytics events for published versions of the specified atlaskit package.\n\n   ").concat(_chalk.default.green('Options'), "\n     ").concat(_chalk.default.yellow('--since'), "       Only publish versions since the following JS date string (exclusive)\n\n   ").concat(_chalk.default.green('Examples'), "\n     ").concat(_chalk.default.dim('$ atlaskit-version-analytics populate-package @atlaskit/button'), "\n");
-function run(_ref) {
-  var dev = _ref.dev;
-  var cli = (0, _meow.default)(HELP_MSG, {
+const HELP_MSG = `
+${_chalk.default.green('Global options')}
+     ${_chalk.default.yellow('--dev')}            Send analytics to dev analytics pipeline instead of prod
+     ${_chalk.default.yellow('--dryRun')}         Performs a dry run, prints analytics events to console in JSON format instead of sending them
+     ${_chalk.default.yellow('--limit')}          Limit the number of events sent, used for validation purposes
+     ${_chalk.default.yellow('--no-interactive')} Disable any interactive prompts
+     ${_chalk.default.yellow('--include-restricted-scopes')}    Include analytics for @atlassian and @atlassiansox scoped packages as well
+
+${_chalk.default.yellow.bold('[populate-product] <product>')}
+   Sends analytics events for atlaskit dependency versions changes in package.json.
+
+   Detects changes since the last time the tool was run by storing the last run in either statlas (--statlas flag) or using the
+   'atlaskit-dependency-version-analytics-last-run' git tag.
+   If running the tool for the first time (last run does not exist), --reset must be used to detect changes since the beginning of the repo.
+
+   ${_chalk.default.green('Options')}
+     ${_chalk.default.yellow('--csv')}         Prints dependency history in CSV format
+     ${_chalk.default.yellow('--reset')}       Reset change detection to detect changes from the beginning of time
+     ${_chalk.default.yellow('--tag')}         Specify a different tag to mark when the tool was last run
+     ${_chalk.default.yellow('--statlas')}     Use statlas rather than git tags for storing and sourcing last run info
+
+   ${_chalk.default.green('Examples')}
+     ${_chalk.default.dim('$ atlaskit-version-analytics populate-product jira')}
+
+${_chalk.default.yellow.bold('[populate-package] <package>')}
+   Sends analytics events for published versions of the specified package.
+
+   ${_chalk.default.green('Options')}
+     ${_chalk.default.yellow('--since')}       Only publish versions since the following JS date string (exclusive)
+
+   ${_chalk.default.green('Examples')}
+     ${_chalk.default.dim('$ atlaskit-version-analytics populate-package @atlaskit/button')}
+`;
+function run({
+  dev
+}) {
+  const cli = (0, _meow.default)(HELP_MSG, {
     flags: {
       csv: {
         type: 'boolean'
@@ -45,15 +77,16 @@ function run(_ref) {
       },
       statlas: {
         type: 'boolean'
+      },
+      includeRestrictedScopes: {
+        type: 'boolean'
       }
     }
   });
-  var _cli$input = (0, _toArray2.default)(cli.input),
-    command = _cli$input[0],
-    inputs = _cli$input.slice(1);
-  var limit = cli.flags.limit != null ? +cli.flags.limit : undefined;
+  const [command, ...inputs] = cli.input;
+  const limit = cli.flags.limit != null ? +cli.flags.limit : undefined;
   if (command === 'populate-product') {
-    var product = inputs[0];
+    const product = inputs[0];
     if (!product) {
       console.error(_chalk.default.red('Must pass a product parameter'));
       process.exit(1);
@@ -63,14 +96,15 @@ function run(_ref) {
       dev: dev || cli.flags.dev || false,
       dryRun: cli.flags.dryRun || false,
       interactive: cli.flags.interactive,
-      limit: limit,
-      product: product,
+      limit,
+      product,
       reset: cli.flags.reset || false,
       statlas: cli.flags.statlas,
-      tag: cli.flags.tag
+      tag: cli.flags.tag,
+      includeRestrictedScopes: cli.flags.includeRestrictedScopes || false
     });
   } else if (command === 'populate-package') {
-    var pkg = inputs[0];
+    const pkg = inputs[0];
     if (!pkg) {
       console.error(_chalk.default.red('Must pass a package parameter'));
       process.exit(1);
@@ -79,9 +113,10 @@ function run(_ref) {
       dev: dev || cli.flags.dev || false,
       dryRun: cli.flags.dryRun || false,
       interactive: cli.flags.interactive,
-      limit: limit,
-      pkg: pkg,
-      since: cli.flags.since
+      limit,
+      pkg,
+      since: cli.flags.since,
+      includeRestrictedScopes: cli.flags.includeRestrictedScopes || false
     });
   }
 

package/dist/cjs/commands/populate-historic-data/index.js

@@ -6,13 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "populatePackage", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _package.default;
   }
 });
 Object.defineProperty(exports, "populateProduct", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _product.default;
   }
 });