Initialize repository

Author: rtsao

.eslintrc

@@ -0,0 +1,16 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2017,
+  },
+  "plugins": [
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": ["error", {
+      "singleQuote": true,
+      "trailingComma": "all",
+      "bracketSpacing": false,
+      "jsxBracketSameLine": true
+    }]
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+npm-debug.log
+*.pem
+.env

.travis.yml

@@ -0,0 +1,12 @@
+dist: trusty
+sudo: false
+language: node_js
+node_js: 8.6.0
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.2.0
+  - export PATH=$HOME/.yarn/bin:$PATH
+cache:
+  yarn: true
+before_install: yarn global add greenkeeper-lockfile@1
+before_script: greenkeeper-lockfile-update
+after_script: greenkeeper-lockfile-upload

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Uber Technologies, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,15 @@
+# probot-app-migrations
+
+> a GitHub App built with [probot](https://github.com/probot/probot) that enforces the creation of migration guides
+
+## Setup
+
+```
+# Install dependencies
+npm install
+
+# Run the bot
+npm start
+```
+
+See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.

__tests__/index.js

@@ -0,0 +1,5 @@
+const t = require('assert');
+
+test('dummy test', () => {
+  t.ok(true, 'dummy assertion passed');
+});

docs/deploy.md

@@ -0,0 +1,7 @@
+# Deploying
+
+If you would like to run your own instance of this app, see the [docs for deployment](https://probot.github.io/docs/deployment/).
+
+This app requires these **Permissions & events** for the GitHub App:
+
+> **TODO**: List permissions required for deployment here. See [probot/stale](https://github.com/probot/stale/blob/master/docs/deploy.md) for an example.

index.js

@@ -0,0 +1,108 @@
+const {join, dirname, basename, sep} = require('path');
+
+const statuses = {
+  passing: {
+    state: 'success',
+    description: 'Migration guide provided',
+  },
+  failing: {
+    state: 'failure',
+    description: 'PRs with breaking changes must provide a migration guide',
+    // target_url: 'https://github.com/',
+  },
+};
+
+module.exports = robot => {
+  robot.on('pull_request.opened', check);
+  robot.on('pull_request.edited', check);
+  robot.on('pull_request.synchronize', check);
+  robot.on('pull_request.updated', check);
+  robot.on('pull_request.labeled', check);
+  robot.on('pull_request.unlabeled', check);
+
+  async function check(context) {
+    const pr = context.payload.pull_request;
+
+    function setStatus(status) {
+      const params = Object.assign(
+        {
+          sha: pr.head.sha,
+          context: 'migration',
+        },
+        status,
+      );
+      return github.repos.createStatus(context.repo(params));
+    }
+
+    const filename = `${pr.number.toString().padStart(5, '0')}.md`;
+
+    const labels = await context.github.issues.getIssueLabels(
+      context.repo({number: pr.number}),
+    );
+
+    const isBreaking = labels.data.reduce((breaking, label) => {
+      return breaking || label.name === 'breaking';
+    }, false);
+
+    if (isBreaking) {
+      const compare = await context.github.repos.compareCommits(
+        context.repo({
+          base: pr.base.sha,
+          head: pr.head.sha,
+        }),
+      );
+
+      const packages = [''];
+
+      compare.data.files.forEach(file => {
+        const subpackage = inSubPackage(file.filename);
+        if (subpackage) {
+          packages.push(subpackage);
+        }
+      });
+
+      Promise.all(
+        packages.map(async pkg => {
+          try {
+            const res = await context.github.repos.getContent(
+              context.repo({
+                path: join(pkg, 'docs/migrations'),
+                ref: pr.head.sha,
+              }),
+            );
+            const files = res.data.map(file => file.path);
+            return files;
+          } catch (err) {
+            if (err.code !== 404) {
+              throw err;
+            }
+            return [];
+          }
+        }),
+      ).then(res => {
+        /**
+         * At least one package needs to have a migration guide
+         */
+        const didPass = res.reduce((outer, files) => {
+          return files.reduce((inner, filepath) => {
+            return inner || basename(filepath) === filename;
+          }, outer);
+        }, false);
+        setStatus(didPass ? statuses.passing : statuses.failing);
+      });
+    } else {
+      setStatus(statuses.passing);
+    }
+  }
+};
+
+function inSubPackage(filepath) {
+  const dirs = dirname(filepath).split(sep);
+  if (dirs.length < 2) {
+    return false;
+  }
+  if (dirs[0] !== 'packages') {
+    return false;
+  }
+  return join(dirs[0], dirs[1]);
+}

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "probot-app-migrations",
+  "version": "1.0.0",
+  "description": "GitHub App that that enforces the creation of migration guides",
+  "author": "Ryan Tsao <[email protected]>",
+  "contributors": [],
+  "repository": "https://github.com/uber-web/probot-app-migrations.git",
+  "scripts": {
+    "start": "probot run ./index.js",
+    "test": "npm run lint && jest",
+    "lint": "eslint .",
+    "fix": "eslint . --fix"
+  },
+  "dependencies": {
+    "probot": "^0.11.0"
+  },
+  "devDependencies": {
+    "eslint": "^4.8.0",
+    "eslint-plugin-prettier": "^2.3.1",
+    "jest": "^21.2.1",
+    "localtunnel": "^1.8.3",
+    "prettier": "^1.7.4"
+  },
+  "engines": {
+    "node": ">= 8.6.0"
+  },
+  "license": "MIT"
+}