Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency simple-git to v2 #3432

Merged
merged 1 commit into from
Aug 25, 2020
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 17, 2020

This PR contains the following updates:

Package Type Update Change
simple-git devDependencies major 1.132.0 -> 2.20.1

Release Notes

steveukx/git-js

v2.20.1

Compare Source

  • LogOptions should be intersection rather than union types

v2.20.0

Compare Source

v2.19.0

Compare Source

  • move the command/task option processing function to TypeScript

v2.18.0

Compare Source

  • git.clone and git.mirror rewritten to fit the TypeScript tasks style.
  • resolves issue whereby git.clone didn't accept an object of options despite being documented as supporting.

v2.17.0

Compare Source

  • git pull (and by extension git merge) adds remote message parsing to the PullResult type
  • Remote message parsing adds property remoteMessages.objects of type RemoteMessagesObjectEnumeration to capture the objects transferred in fetch and push.

v2.16.0

Compare Source

  • git.mv rewritten to fit the TypeScript tasks style.
  • set up github actions for CI

v2.15.0

Compare Source

  • adds the TaskParser type to describe a task's parser function and creates the LineParser utility to simplify line-by-line parsing of string responses.
  • renames some interfaces for consistency of naming, the original name remains as a type alias marked as @deprecated until version 3.x:
    • BranchDeletionSummary > BranchSingleDeleteResult
    • BranchDeletionBatchSummary > BranchMultiDeleteResult
    • MergeSummary > MergeResult

v2.14.0

Compare Source

  • resolves an issue whereby the git.checkoutBranch method would not pass the branch detail through to the underlying child process.

v2.13.2

Compare Source

  • Further to 2.13.0 includes all (non-empty) remote: lines in the PushResult,
    including remote: lines used for other parser results (ie: pullRequestUrl etc).

v2.13.1

Compare Source

  • Further to 2.13.0 adding support for parsing the reponse to git.push, adds support for the pull request message
    used by gitlab.

v2.13.0

Compare Source

  • .push and .pushTags rewritten as v2 style tasks. The git response is now parsed and returned as a
    PushResult

  • Pull and merge rewritten to fit the TypeScript tasks style.

  • Integration tests updated to run through jest directly without compiling from nodeunit

v2.12.0

Compare Source

  • resolves an issue whereby the git.tags method could not be chained or used as an async/promise.

v2.11.0

Compare Source

  • until now, simple-git reject all pending tasks in the queue when a task has failed. From 2.11.0, only
    tasks chained from the failing one will be rejected, other tasks can continue to be processed as normal,
    giving the developer more control over which tasks should be treated as atomic chains, and which can be
    run in parallel.

    To support this, and to prevent the issues seen when git is run concurrently in too many child processes,
    simple-git will limit the number of tasks running in parallel at any one time to be at most 1 from each
    chain (ie: chained tasks are still run in series) and at most 5 tasks across all chains (
    configurable by passing {maxConcurrentProcesses: x} in the simpleGit constructor).

  • add support to git.status() for parsing the response of a repo that has no commits yet, previously
    it wouldn't determine the branch name correctly.

  • resolved a flaw introduced in 2.9.0 whereby checkoutLocalBranch would silently fail and not check out the branch

v2.10.0

Compare Source

  • git.checkout now supports both object and array forms of supplying trailing options.
import simpleGit from 'simple-git';
await simpleGit().checkout('branch-name', ['--track', 'remote/branch']);
await simpleGit().checkout(['branch-name', '--track', 'remote/branch']);
await simpleGit().checkout({'branch-name': null});
  • git.init now supports both object and array forms of supplying trailing options and now
    parses the response to return an InitResult;
import simpleGit, { InitResult } from 'simple-git';
const notSharedInit: InitResult = await simpleGit().init(false, ['--shared=false']);
const notSharedBareInit: InitResult = await simpleGit().init(['--bare', '--shared=false']);
const sharedInit: InitResult = await simpleGit().init(false, {'--shared': 'true'});
const sharedBareInit: InitResult = await simpleGit().init({'--bare': null, '--shared': 'false'});
  • git.status now supports both object and array forms of supplying trailing options.
import simpleGit, { StatusResult } from 'simple-git';
const repoStatus: StatusResult = await simpleGit().status();
const subDirStatus: StatusResult = await simpleGit().status(['--', 'sub-dir']);
  • git.reset upgraded to the new task style and exports an enum ResetMode with all supported
    merge modes and now supports both object and array forms of supplying trailing options.
import simpleGit, { ResetMode } from 'simple-git';

// git reset --hard
await simpleGit().reset(ResetMode.HARD);

// git reset --soft -- sub-dir
await simpleGit().reset(ResetMode.SOFT, ['--', 'sub-dir']);
  • bug-fix: it should not be possible to await the simpleGit() task runner, only the tasks it returns.
expect(simpleGit().then).toBeUndefined();
expect(simpleGit().init().then).toBe(expect.any(Function));

v2.9.0

Compare Source

  • .checkIsRepo() updated to allow choosing the type of check to run, either by using the exported CheckRepoActions enum
    or the text equivalents ('bare', 'root' or 'tree'):

    • checkIsRepo(CheckRepoActions.BARE): Promise<boolean> determines whether the working directory represents a bare repo.
    • checkIsRepo(CheckRepoActions.IS_REPO_ROOT): Promise<boolean> determines whether the working directory is at the root of a repo.
    • checkIsRepo(CheckRepoActions.IN_TREE): Promise<boolean> determines whether the working directory is a descendent of a git root.
  • .revparse() converted to a new style task

v2.8.0

Compare Source

  • Enables support for using the default export of simple-git as an es module, in TypeScript it is no
    longer necessary to enable the esModuleInterop flag in the tsconfig.json to consume the default
    export.
2.7.2 - Bug Fix: Remove promise.ts source from simple-git published artifact
  • Closes #​471, whereby the source for the promise wrapped runner would be included in the published artifact
    due to sharing the same name as the explicitly included promise.js in the project root.
2.7.1 - Bug Fix: await git.log having imported from root simple-git
  • Fixes #​464, whereby using await on git.log without having supplied a callback would ignore the leading options
    object or options array.

v2.7.2

Compare Source

  • Closes #​471, whereby the source for the promise wrapped runner would be included in the published artifact
    due to sharing the same name as the explicitly included promise.js in the project root.

v2.7.1

Compare Source

  • Fixes #​464, whereby using await on git.log without having supplied a callback would ignore the leading options
    object or options array.

v2.7.0

Compare Source

  • Updated to the outputHandler type to add a trailing argument for the arguments passed into the child process.
  • All logging now uses the debug library. Enable logging by adding simple-git
    to the DEBUG environment variable. git.silent(false) can still be used to explicitly enable logging and is
    equivalent to calling require('debug').enable('simple-git').

v2.6.0

Compare Source

Native Promises
  • TL;DR - .then and .catch can now be called on the standard simpleGit chain to handle the promise
    returned by the most recently added task... essentially, promises now just work the way you would expect
    them to.
  • The main export from simple-git no longer shows the deprecation notice for using the
    .then function, it now exposes the promise chain generated from the most recently run
    task, allowing the combination of chain building and ad-hoc splitting off to a new promise chain.
TypeScript Importing
  • Promise / async interface and TypeScript types all available from the simple-git import rather than needing
    simple-git/promise, see examples in the ReadMe or in the consumer tests.
Typed Errors
  • Tasks that previously validated their usage and rejected with a TypeError will now reject with a
    TaskConfigurationError.

  • Tasks that previously rejected with a custom object (currently only git.merge when the auto-merge fails)
    will now reject with a GitResponseError where previously it
    was a modified Error.

Git Clean
  • git.clean(...) will now return a CleanSummary instead of the raw string data
Git Raw
  • git.raw(...) now accepts any number of leading string arguments as an alternative to the
    single array of strings.

v2.5.0

Compare Source

  • all git.remote related functions converted to TypeScript

v2.4.0

Compare Source

  • all git.subModule related functions converted to TypeScript

v2.3.0

Compare Source

  • add new git.listConfig to get current configuration
  • git.addConfig supports a new append flag to append the value into the config rather than overwrite existing

v2.2.0

Compare Source

  • all git.branch related functions converted to TypeScript
  • add new git.deleteLocalBranches to delete multiple branches in one call
  • git.deleteLocalBranches and git.deleteLocalBranch now support an optional forceDelete flag

v2.1.0

Compare Source

  • .tags, .addTag and .addAnnotatedTag converted to TypeScript, no backward compatibility changes

v2.0.0

Compare Source

  • If your application depended on any functions with a name starting with an _, the upgrade may not be seamless,
    please only use the documented public API.

  • git.log date format is now strict ISO by default (ie: uses the placeholder %aI) instead of the 1.x default of
    %ai for an "ISO-like" date format. To restore the old behaviour, add strictDate = false to the options passed to
    git.log.


Renovate configuration

📅 Schedule: "before 3am on Friday" (UTC).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by WhiteSource Renovate. View repository job log here.

@changeset-bot
Copy link

changeset-bot bot commented Jul 17, 2020

💥 No Changeset

Latest commit: 800d41f

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jul 17, 2020

Binary Size Report

Affected SDKs

No changes between base commit (c0f2be0) and head commit (4403720).

Test Logs

@renovate renovate bot force-pushed the renovate/simple-git-2.x branch 3 times, most recently from 4b57034 to 96b5666 Compare July 23, 2020 11:37
@renovate renovate bot force-pushed the renovate/simple-git-2.x branch from 96b5666 to 8f6973a Compare July 24, 2020 21:41
@renovate renovate bot force-pushed the renovate/simple-git-2.x branch from 7617561 to 46a350b Compare August 25, 2020 18:35
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Aug 25, 2020

Size Analysis Report

Affected Products

No changes between base commit (c0f2be0) and head commit (4403720).

Test Logs

@renovate renovate bot force-pushed the renovate/simple-git-2.x branch from 46a350b to 800d41f Compare August 25, 2020 19:16
@Feiyang1 Feiyang1 merged commit 05b5606 into master Aug 25, 2020
@Feiyang1 Feiyang1 deleted the renovate/simple-git-2.x branch August 25, 2020 20:53
@firebase firebase locked and limited conversation to collaborators Sep 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants