Show existing backports on commit list

- Show existing backports on commit list - Add option to choose number of commits to be listed (Closes #76) - Add options to filter commits by username - Show link to authorize sso on access token in error message - do not track baseBranch when creating feature branch - cleanup by removing local feature branch after push - delete “origin” remote to avoid confusion - Migrate some APIs to graphql (closes #63)
sorenlouv · Jul 6, 2019 · 7b54834 · 7b54834
1 parent 0245a6b
commit 7b54834
Show file tree

Hide file tree

Showing 60 changed files with 2,299 additions and 1,462 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,15 +1,17 @@
 module.exports = {
-  plugins: ['@typescript-eslint'],
+  plugins: ['@typescript-eslint', 'import'],
   parser: '@typescript-eslint/parser', // Specifies the ESLint parser
   extends: [
     'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
     'prettier/@typescript-eslint', // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
     'plugin:prettier/recommended' // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
   ],
   rules: {
+    'import/order': 2,
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/no-use-before-define': 'off',
     '@typescript-eslint/camelcase': 'off',
-    '@typescript-eslint/explicit-member-accessibility': 'off'
+    '@typescript-eslint/explicit-member-accessibility': 'off',
+    '@typescript-eslint/no-explicit-any': 'off'
   }
 };
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,6 +16,19 @@ yarn tsc
 node dist/index.js --branch 6.1 --upstream sqren/backport-demo --all
 ```
 
+**Run `backport` CLI globally**
+
+```
+yarn global remove backport
+npm -g uninstall backport
+yarn unlink backport
+yarn link
+sudo chmod +x dist/index.js
+yarn tsc --watch
+```
+
+You can now use `backport` command anywhere, and it'll point to the development version.
+
 ### Debug
 
 **Run tests**

diff --git a/README.md b/README.md
@@ -87,7 +87,9 @@ The above commands will start an interactive prompt. You can use the `arrow keys
 | --accessToken   | Github access token                     |                                 | string  |
 | --all           | Show commits from other than me         | false                           | boolean |
 | --apiHostname   | Hostname for the Github API             | api.github.com                  | string  |
+| --author        | Filter commits by author                | _Current user_                  | string  |
 | --branch        | Branch to backport to                   |                                 | string  |
+| --commitsCount  | Number of commits to choose from        | 10                              | number  |
 | --gitHostname   | Hostname for Git remotes                | github.com                      | string  |
 | --labels        | Pull request labels                     |                                 | string  |
 | --multiple      | Select multiple branches and/or commits | false                           | boolean |

diff --git a/package.json b/package.json
@@ -29,7 +29,7 @@
   "scripts": {
     "cover": "jest --coverage",
     "format": "prettier \"./src/**/*.ts\" --write",
-    "lint": "tsc -p ./test/tsconfig.json && eslint ./src/**/*.ts",
+    "lint": "tsc -p ./test/tsconfig.json && eslint ./src/**/*.ts ./test/**/*.ts",
     "postinstall": "test -f ./dist/scripts/runPostinstall.js && node ./dist/scripts/runPostinstall.js || echo 'Dist folder missing'",
     "prepublishOnly": "tsc",
     "publish-dry-run": "tar -tf $(npm pack)",
@@ -98,35 +98,36 @@
     "yargs": "^13.2.2"
   },
   "devDependencies": {
-    "@types/core-js": "^2.5.0",
+    "@types/core-js": "^2.5.2",
     "@types/find-up": "^2.1.1",
-    "@types/inquirer": "^6.0.0",
-    "@types/jest": "^24.0.11",
+    "@types/inquirer": "^6.0.3",
+    "@types/jest": "^24.0.15",
     "@types/lodash.flatten": "^4.4.6",
     "@types/lodash.get": "^4.4.6",
     "@types/lodash.isempty": "^4.4.6",
     "@types/lodash.isstring": "^4.0.6",
     "@types/lodash.last": "^3.0.6",
     "@types/mkdirp": "^0.5.2",
-    "@types/nock": "^10.0.0",
+    "@types/nock": "^10.0.3",
     "@types/node": "^10.14.4",
     "@types/rimraf": "^2.0.2",
     "@types/strip-json-comments": "^0.0.30",
     "@types/yargs": "^13.0.0",
-    "@typescript-eslint/eslint-plugin": "^1.7.0",
-    "@typescript-eslint/parser": "^1.7.0",
+    "@typescript-eslint/eslint-plugin": "^1.11.0",
+    "@typescript-eslint/parser": "^1.11.0",
     "axios-mock-adapter": "^1.16.0",
-    "eslint": "^5.16.0",
-    "eslint-config-prettier": "^4.1.0",
-    "eslint-plugin-prettier": "^3.0.1",
-    "husky": "^2.0.0",
-    "jest": "^24.7.1",
-    "lint-staged": "^8.1.5",
+    "eslint": "^6.0.1",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-plugin-import": "^2.18.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "husky": "^2.7.0",
+    "jest": "^24.8.0",
+    "lint-staged": "^8.2.1",
     "lodash.last": "^3.0.0",
     "nock": "^10.0.6",
-    "prettier": "^1.17.0",
+    "prettier": "^1.18.2",
     "ts-jest": "^24.0.2",
-    "ts-node": "^8.1.0",
-    "typescript": "^3.4.5"
+    "ts-node": "^8.3.0",
+    "typescript": "^3.5.2"
   }
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-import { initSteps } from './steps/steps';
 import { getOptions } from './options/options';
+import { initSteps } from './steps/steps';
 
 async function init() {
   try {

diff --git a/src/options/cliArgs.ts b/src/options/cliArgs.ts
@@ -24,13 +24,23 @@ export function getOptionsFromCliArgs(
       description: 'Hostname for the Github API',
       type: 'string'
     })
+    .option('author', {
+      default: configOptions.author,
+      description: 'Show commits by specific author',
+      type: 'string'
+    })
     .option('branches', {
       default: [] as string[],
       description: 'Branch(es) to backport to',
       type: 'array',
       alias: 'branch',
       string: true // ensure `6.0` is not coerced to `6`
     })
+    .option('commitsCount', {
+      default: configOptions.commitsCount,
+      description: 'Number of commits to choose from',
+      type: 'number'
+    })
     .option('gitHostname', {
       default: configOptions.gitHostname,
       description: 'Hostname for Github',
@@ -89,6 +99,8 @@ export function getOptionsFromCliArgs(
     accessToken: cliArgs.accessToken,
     all: cliArgs.all,
     apiHostname: cliArgs.apiHostname,
+    author: cliArgs.author,
+    commitsCount: cliArgs.commitsCount,
     branchChoices: configOptions.branchChoices,
     branches: cliArgs.branches,
     gitHostname: cliArgs.gitHostname,

diff --git a/src/options/config/config.ts b/src/options/config/config.ts
@@ -1,8 +1,8 @@
+import isString from 'lodash.isstring';
+import { Config } from '../../types/Config';
+import { PromiseReturnType } from '../../types/commons';
 import { getGlobalConfig } from './globalConfig';
 import { getProjectConfig } from './projectConfig';
-import { PromiseReturnType } from '../../types/commons';
-import { Config } from '../../types/Config';
-import isString from 'lodash.isstring';
 
 export type OptionsFromConfigFiles = PromiseReturnType<
   typeof getOptionsFromConfigFiles

diff --git a/src/options/config/globalConfig.ts b/src/options/config/globalConfig.ts
@@ -1,6 +1,6 @@
-import { readConfigFile } from './readConfigFile';
-import { mkdirp, chmod, writeFile } from '../../services/rpc';
+import { chmod, mkdirp, writeFile } from '../../services/rpc';
 import { getGlobalConfigPath, getReposPath } from '../../services/env';
+import { readConfigFile } from './readConfigFile';
 
 export async function getGlobalConfig() {
   await maybeCreateGlobalConfigAndFolder();

diff --git a/src/options/config/readConfigFile.ts b/src/options/config/readConfigFile.ts
@@ -1,7 +1,7 @@
 import stripJsonComments from 'strip-json-comments';
+import { Config } from '../../types/Config';
 import { HandledError } from '../../services/HandledError';
 import { readFile } from '../../services/rpc';
-import { Config } from '../../types/Config';
 
 export async function readConfigFile(filepath: string) {
   const fileContents = await readFile(filepath, 'utf8');

diff --git a/src/options/options.ts b/src/options/options.ts
@@ -1,9 +1,9 @@
 import isEmpty from 'lodash.isempty';
 import { HandledError } from '../services/HandledError';
-import { OptionsFromCliArgs, getOptionsFromCliArgs } from './cliArgs';
-import { getOptionsFromConfigFiles } from './config/config';
 import { PromiseReturnType } from '../types/commons';
 import { getGlobalConfigPath } from '../services/env';
+import { OptionsFromCliArgs, getOptionsFromCliArgs } from './cliArgs';
+import { getOptionsFromConfigFiles } from './config/config';
 
 export type BackportOptions = Readonly<PromiseReturnType<typeof getOptions>>;
 export async function getOptions(argv: typeof process.argv) {

diff --git a/src/services/env.ts b/src/services/env.ts
@@ -1,5 +1,5 @@
-import path from 'path';
 import os from 'os';
+import path from 'path';
 import { BackportOptions } from '../options/options';
 
 export function getGlobalConfigPath() {

diff --git a/src/services/git.ts b/src/services/git.ts
@@ -1,9 +1,9 @@
 import childProcess from 'child_process';
 import rimraf from 'rimraf';
-import { exec, stat } from './rpc';
-import { HandledError } from './HandledError';
-import { getRepoPath, getRepoOwnerPath } from './env';
 import { BackportOptions } from '../options/options';
+import { HandledError } from './HandledError';
+import { exec, stat } from './rpc';
+import { getRepoOwnerPath, getRepoPath } from './env';
 
 async function folderExists(path: string): Promise<boolean> {
   try {
@@ -87,9 +87,7 @@ export async function deleteRemote(
 export async function addRemote(options: BackportOptions, remoteName: string) {
   try {
     await exec(
-      `git remote add ${remoteName} https://${options.accessToken}@${
-        options.gitHostname
-      }/${remoteName}/${options.repoName}.git`,
+      `git remote add ${remoteName} https://${options.accessToken}@${options.gitHostname}/${remoteName}/${options.repoName}.git`,
       {
         cwd: getRepoPath(options)
       }
@@ -101,9 +99,12 @@ export async function addRemote(options: BackportOptions, remoteName: string) {
 }
 
 export function cherrypick(options: BackportOptions, commitSha: string) {
-  return exec(`git cherry-pick ${commitSha}`, {
-    cwd: getRepoPath(options)
-  });
+  return exec(
+    `git fetch ${options.repoOwner} master:master --force && git cherry-pick ${commitSha}`,
+    {
+      cwd: getRepoPath(options)
+    }
+  );
 }
 
 export async function isIndexDirty(options: BackportOptions) {
@@ -117,14 +118,14 @@ export async function isIndexDirty(options: BackportOptions) {
   }
 }
 
-export async function createAndCheckoutBranch(
+export async function createFeatureBranch(
   options: BackportOptions,
   baseBranch: string,
   featureBranch: string
 ) {
   try {
     return await exec(
-      `git fetch origin ${baseBranch} && git branch ${featureBranch} origin/${baseBranch} --force && git checkout ${featureBranch} `,
+      `git reset --hard && git clean -d --force && git fetch ${options.repoOwner} ${baseBranch} && git checkout -B ${featureBranch} ${options.repoOwner}/${baseBranch} --no-track`,
       {
         cwd: getRepoPath(options)
       }
@@ -142,18 +143,21 @@ export async function createAndCheckoutBranch(
   }
 }
 
-export function push(options: BackportOptions, featureBranch: string) {
-  return exec(
-    `git push ${options.username} ${featureBranch}:${featureBranch} --force`,
-    {
-      cwd: getRepoPath(options)
-    }
-  );
+export function deleteFeatureBranch(
+  options: BackportOptions,
+  featureBranch: string
+) {
+  return exec(`git checkout master && git branch -D ${featureBranch}`, {
+    cwd: getRepoPath(options)
+  });
 }
 
-export async function resetAndPullMaster(options: BackportOptions) {
+export function pushFeatureBranch(
+  options: BackportOptions,
+  featureBranch: string
+) {
   return exec(
-    `git reset --hard && git clean -d --force && git checkout master && git pull origin master`,
+    `git push ${options.username} ${featureBranch}:${featureBranch} --force`,
     {
       cwd: getRepoPath(options)
     }