feat: create Scm abstraction

__snapshots__/cli.js

@@ -25,6 +25,9 @@ Options:
   --repo-url                    GitHub URL to generate release for    [required]
   --dry-run                     Prepare but do not take action
                                                       [boolean] [default: false]
+  --local                       Whether to use local clone
+                                                      [boolean] [default: false]
+  --local-path                  Path to existing local clone            [string]
   --include-v-in-tags           include "v" in tag versions
                                                        [boolean] [default: true]
   --monorepo-tags               include library name in tags and release
@@ -97,6 +100,8 @@ Options:
                         on                                              [string]
   --repo-url            GitHub URL to generate release for            [required]
   --dry-run             Prepare but do not take action[boolean] [default: false]
+  --local               Whether to use local clone    [boolean] [default: false]
+  --local-path          Path to existing local clone                    [string]
   --label               comma-separated list of labels to add to from release PR
                                                [default: "autorelease: pending"]
   --skip-labeling       skip application of labels to pull requests
@@ -138,6 +143,8 @@ Options:
                         on                                              [string]
   --repo-url            GitHub URL to generate release for            [required]
   --dry-run             Prepare but do not take action[boolean] [default: false]
+  --local               Whether to use local clone    [boolean] [default: false]
+  --local-path          Path to existing local clone                    [string]
   --draft               mark release as a draft. no tag is created but tag_name
                         and target_commitish are associated with the release for
                         future tag creation upon "un-drafting" the release.
@@ -187,6 +194,9 @@ Options:
   --repo-url                        GitHub URL to generate release for[required]
   --dry-run                         Prepare but do not take action
                                                       [boolean] [default: false]
+  --local                           Whether to use local clone
+                                                      [boolean] [default: false]
+  --local-path                      Path to existing local clone        [string]
   --release-as                      override the semantically determined release
                                     version                             [string]
   --bump-minor-pre-major            should we bump the semver minor prior to the

package.json

@@ -5,7 +5,7 @@
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
   "scripts": {
-    "test": "cross-env ENVIRONMENT=test LC_ALL=en c8 mocha --node-option no-experimental-fetch --recursive --timeout=5000 build/test",
+    "test": "cross-env ENVIRONMENT=test LC_ALL=en c8 mocha --recursive --timeout=5000 build/test",
     "docs": "echo add docs tests",
     "test:snap": "cross-env SNAPSHOT_UPDATE=1 LC_ALL=en npm test",
     "clean": "gts clean",

src/bin/release-please.ts

@@ -16,7 +16,8 @@
 
 import {coerceOption} from '../util/coerce-option';
 import * as yargs from 'yargs';
-import {GitHub, GH_API_URL, GH_GRAPHQL_URL} from '../github';
+import {GitHub} from '../github';
+import {GH_API_URL, GH_GRAPHQL_URL} from '../github-api';
 import {Manifest, ManifestOptions, ROOT_PROJECT_PATH} from '../manifest';
 import {ChangelogSection, buildChangelogSections} from '../changelog-notes';
 import {logger, setLogger, CheckpointLogger} from '../util/logger';
@@ -30,6 +31,8 @@ import {
 } from '../factory';
 import {Bootstrapper} from '../bootstrapper';
 import {createPatch} from 'diff';
+import {Scm} from '../scm';
+import {LocalGitHub} from '../local-github';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const parseGithubRepoUrl = require('parse-github-repo-url');
@@ -49,6 +52,8 @@ interface GitHubArgs {
   apiUrl?: string;
   graphqlUrl?: string;
   fork?: boolean;
+  local?: boolean;
+  localPath?: string;
 
   // deprecated in favor of targetBranch
   defaultBranch?: string;
@@ -187,6 +192,15 @@ function gitHubOptions(yargs: yargs.Argv): yargs.Argv {
       type: 'boolean',
       default: false,
     })
+    .option('local', {
+      describe: 'Whether to use local clone',
+      type: 'boolean',
+      default: false,
+    })
+    .option('local-path', {
+      describe: 'Path to existing local clone',
+      type: 'string',
+    })
     .middleware(_argv => {
       const argv = _argv as GitHubArgs;
       // allow secrets to be loaded from file path
@@ -817,16 +831,28 @@ const debugConfigCommand: yargs.CommandModule<{}, DebugConfigArgs> = {
   },
 };
 
-async function buildGitHub(argv: GitHubArgs): Promise<GitHub> {
+async function buildGitHub(argv: GitHubArgs): Promise<Scm> {
   const [owner, repo] = parseGithubRepoUrl(argv.repoUrl);
-  const github = await GitHub.create({
-    owner,
-    repo,
-    token: argv.token!,
-    apiUrl: argv.apiUrl,
-    graphqlUrl: argv.graphqlUrl,
-  });
-  return github;
+  if (argv.local) {
+    const localGitHub = await LocalGitHub.create({
+      owner,
+      repo,
+      token: argv.token!,
+      apiUrl: argv.apiUrl,
+      graphqlUrl: argv.graphqlUrl,
+      localRepoPath: argv.localPath,
+    });
+    return localGitHub;
+  } else {
+    const github = await GitHub.create({
+      owner,
+      repo,
+      token: argv.token!,
+      apiUrl: argv.apiUrl,
+      graphqlUrl: argv.graphqlUrl,
+    });
+    return github;
+  }
 }
 
 export const parser = yargs

src/bootstrapper.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {GitHub} from './github';
+import {Scm} from './scm';
 import {
   DEFAULT_RELEASE_PLEASE_MANIFEST,
   DEFAULT_RELEASE_PLEASE_CONFIG,
@@ -30,13 +30,13 @@ interface BootstrapPullRequest extends PullRequest {
 }
 
 export class Bootstrapper {
-  private github: GitHub;
+  private github: Scm;
   private targetBranch: string;
   private manifestFile: string;
   private configFile: string;
   private initialVersion: Version;
   constructor(
-    github: GitHub,
+    github: Scm,
     targetBranch: string,
     manifestFile: string = DEFAULT_RELEASE_PLEASE_MANIFEST,
     configFile: string = DEFAULT_RELEASE_PLEASE_CONFIG,

src/changelog-notes/github.ts

@@ -14,11 +14,11 @@
 
 import {ChangelogNotes, BuildNotesOptions} from '../changelog-notes';
 import {ConventionalCommit} from '../commit';
-import {GitHub} from '../github';
+import {Scm} from '../scm';
 
 export class GitHubChangelogNotes implements ChangelogNotes {
-  private github: GitHub;
-  constructor(github: GitHub) {
+  private github: Scm;
+  constructor(github: Scm) {
     this.github = github;
   }
   async buildNotes(

src/factories/changelog-notes-factory.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {GitHub} from '../github';
+import {Scm} from '../scm';
 import {ChangelogNotes, ChangelogSection} from '../changelog-notes';
 import {GitHubChangelogNotes} from '../changelog-notes/github';
 import {DefaultChangelogNotes} from '../changelog-notes/default';
@@ -22,7 +22,7 @@ export type ChangelogNotesType = string;
 
 export interface ChangelogNotesFactoryOptions {
   type: ChangelogNotesType;
-  github: GitHub;
+  github: Scm;
   changelogSections?: ChangelogSection[];
   commitPartial?: string;
   headerPartial?: string;

src/factories/plugin-factory.ts

@@ -19,7 +19,7 @@ import {
   SentenceCasePluginConfig,
   GroupPriorityPluginConfig,
 } from '../manifest';
-import {GitHub} from '../github';
+import {Scm} from '../scm';
 import {ManifestPlugin} from '../plugin';
 import {LinkedVersions} from '../plugins/linked-versions';
 import {CargoWorkspace} from '../plugins/cargo-workspace';
@@ -34,7 +34,7 @@ import {WorkspacePluginOptions} from '../plugins/workspace';
 
 export interface PluginFactoryOptions {
   type: PluginType;
-  github: GitHub;
+  github: Scm;
   targetBranch: string;
   repositoryConfig: RepositoryConfig;
   manifestPath: string;

src/factories/versioning-strategy-factory.ts

@@ -18,7 +18,7 @@ import {AlwaysBumpPatch} from '../versioning-strategies/always-bump-patch';
 import {AlwaysBumpMinor} from '../versioning-strategies/always-bump-minor';
 import {AlwaysBumpMajor} from '../versioning-strategies/always-bump-major';
 import {ServicePackVersioningStrategy} from '../versioning-strategies/service-pack';
-import {GitHub} from '../github';
+import {Scm} from '../scm';
 import {ConfigurationError} from '../errors';
 import {PrereleaseVersioningStrategy} from '../versioning-strategies/prerelease';
 
@@ -30,7 +30,7 @@ export interface VersioningStrategyFactoryOptions {
   bumpPatchForMinorPreMajor?: boolean;
   prereleaseType?: string;
   prerelease?: boolean;
-  github: GitHub;
+  github: Scm;
 }
 
 export type VersioningStrategyBuilder = (

src/factory.ts

@@ -15,7 +15,7 @@
 import {ConfigurationError} from './errors';
 import {buildChangelogNotes} from './factories/changelog-notes-factory';
 import {buildVersioningStrategy} from './factories/versioning-strategy-factory';
-import {GitHub} from './github';
+import {Scm} from './scm';
 import {ReleaserConfig} from './manifest';
 import {BaseStrategyOptions} from './strategies/base';
 import {Bazel} from './strategies/bazel';
@@ -61,7 +61,7 @@ export type ReleaseType = string;
 export type ReleaseBuilder = (options: BaseStrategyOptions) => Strategy;
 
 export interface StrategyFactoryOptions extends ReleaserConfig {
-  github: GitHub;
+  github: Scm;
   path?: string;
   targetBranch?: string;
 }