Update dependency simple-git to v2 #3432
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.132.0
->2.20.1
Release Notes
steveukx/git-js
v2.20.1
Compare Source
LogOptions
should be intersection rather than union typesv2.20.0
Compare Source
v2.19.0
Compare Source
v2.18.0
Compare Source
git.clone
andgit.mirror
rewritten to fit the TypeScript tasks style.git.clone
didn't accept an object of options despite being documented as supporting.v2.17.0
Compare Source
git pull
(and by extensiongit merge
) adds remote message parsing to thePullResult
typeremoteMessages.objects
of typeRemoteMessagesObjectEnumeration
to capture the objects transferred in fetch and push.v2.16.0
Compare Source
git.mv
rewritten to fit the TypeScript tasks style.v2.15.0
Compare Source
TaskParser
type to describe a task's parser function and creates theLineParser
utility to simplify line-by-line parsing of string responses.@deprecated
until version 3.x:v2.14.0
Compare Source
git.checkoutBranch
method would not pass the branch detail through to the underlying child process.v2.13.2
Compare Source
2.13.0
includes all (non-empty)remote:
lines in thePushResult
,including
remote:
lines used for other parser results (ie:pullRequestUrl
etc).v2.13.1
Compare Source
2.13.0
adding support for parsing the reponse togit.push
, adds support for the pull request messageused by gitlab.
v2.13.0
Compare Source
.push
and.pushTags
rewritten as v2 style tasks. The git response is now parsed and returned as aPushResult
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
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. From2.11.0
, onlytasks 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 eachchain (ie: chained tasks are still run in series) and at most 5 tasks across all chains (
configurable by passing
{maxConcurrentProcesses: x}
in thesimpleGit
constructor).add support to
git.status()
for parsing the response of a repo that has no commits yet, previouslyit wouldn't determine the branch name correctly.
resolved a flaw introduced in
2.9.0
wherebycheckoutLocalBranch
would silently fail and not check out the branchv2.10.0
Compare Source
git.checkout
now supports both object and array forms of supplying trailing options.git.init
now supports both object and array forms of supplying trailing options and nowparses the response to return an InitResult;
git.status
now supports both object and array forms of supplying trailing options.git.reset
upgraded to the new task style and exports an enumResetMode
with all supportedmerge modes and now supports both object and array forms of supplying trailing options.
simpleGit()
task runner, only the tasks it returns.v2.9.0
Compare Source
.checkIsRepo()
updated to allow choosing the type of check to run, either by using the exportedCheckRepoActions
enumor 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 taskv2.8.0
Compare Source
simple-git
as an es module, in TypeScript it is nolonger necessary to enable the
esModuleInterop
flag in thetsconfig.json
to consume the defaultexport.
2.7.2 - Bug Fix: Remove
promise.ts
source fromsimple-git
published artifactdue 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 rootsimple-git
await
ongit.log
without having supplied a callback would ignore the leading optionsobject or options array.
v2.7.2
Compare Source
due to sharing the same name as the explicitly included
promise.js
in the project root.v2.7.1
Compare Source
await
ongit.log
without having supplied a callback would ignore the leading optionsobject or options array.
v2.7.0
Compare Source
outputHandler
type to add a trailing argument for the arguments passed into the child process.simple-git
to the
DEBUG
environment variable.git.silent(false)
can still be used to explicitly enable logging and isequivalent to calling
require('debug').enable('simple-git')
.v2.6.0
Compare Source
Native Promises
.then
and.catch
can now be called on the standardsimpleGit
chain to handle the promisereturned by the most recently added task... essentially, promises now just work the way you would expect
them to.
simple-git
no longer shows the deprecation notice for using the.then
function, it now exposes the promise chain generated from the most recently runtask, allowing the combination of chain building and ad-hoc splitting off to a new promise chain.
TypeScript Importing
simple-git
import rather than needingsimple-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 aTaskConfigurationError
.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 itwas a modified
Error
.Git Clean
git.clean(...)
will now return aCleanSummary
instead of the raw string dataGit Raw
git.raw(...)
now accepts any number of leading string arguments as an alternative to thesingle array of strings.
v2.5.0
Compare Source
git.remote
related functions converted to TypeScriptv2.4.0
Compare Source
git.subModule
related functions converted to TypeScriptv2.3.0
Compare Source
git.listConfig
to get current configurationgit.addConfig
supports a newappend
flag to append the value into the config rather than overwrite existingv2.2.0
Compare Source
git.branch
related functions converted to TypeScriptgit.deleteLocalBranches
to delete multiple branches in one callgit.deleteLocalBranches
andgit.deleteLocalBranch
now support an optionalforceDelete
flagv2.1.0
Compare Source
.tags
,.addTag
and.addAnnotatedTag
converted to TypeScript, no backward compatibility changesv2.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, addstrictDate = false
to the options passed togit.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.
This PR has been generated by WhiteSource Renovate. View repository job log here.