Change History & Release Notes

April 11, 2026 · View on GitHub

3.36.0

Minor Changes

  • 89a2294: Extend known exploitable configuration keys and per-task environment variables.

    Note - ParsedVulnerabilities from argv-parser is removed in favour of a readonly array of Vulnerability to match usage in simple-git, rolled into the new vulnerabilityCheck for simpler access to the identified issues.

    Thanks to @zebbern for identifying the need to block core.fsmonitor. Thanks to @kodareef5 for identifying the need to block GIT_CONFIG_COUNT environment variables and --template / merge related config.

Patch Changes

  • 1ad57e8: Remove conflicting node:buffer import
  • Updated dependencies [89a2294]
  • Updated dependencies [675570a]
    • @simple-git/argv-parser@1.1.0
    • @simple-git/args-pathspec@1.0.3

3.35.2

Patch Changes

  • 0cf9d8c: Improvements for mono-repo publishing pipeline
  • Updated dependencies [0cf9d8c]
    • @simple-git/args-pathspec@1.0.2
    • @simple-git/argv-parser@1.0.3

3.35.1

Patch Changes

  • 0de400e: Update monorepo version handling during publish
  • Updated dependencies [0de400e]
    • @simple-git/argv-parser@1.0.2

3.35.0

Minor Changes

  • 3d8708b: Updating publish config

Patch Changes

  • Updated dependencies [3d8708b]
    • @simple-git/args-pathspec@1.0.1
    • @simple-git/argv-parser@1.0.1

3.34.0

Minor Changes

  • 2b68331: Revised dependency tree to add helper modules as dependencies in main simple-git

Patch Changes

  • 2e1f51c: Enhances scanning of arguments before passing on to the spawned child_process.

    Caters for -c flags prefixing the git task (used when setting global inline config) and suffixing with either -c, --config or --config-env. Detects git config operations that write to the configuration.

  • Updated dependencies [2e1f51c]

    • @simple-git/args-pathspec@1.0.0
    • @simple-git/argv-parser@1.0.0

3.33.0

Minor Changes

  • a263635: Use pathspec wrappers for remote and local paths when running either git.clone or git.mirror to avoid leaving them less open for unexpected outcomes when passing unsanitised data into these tasks.

Patch Changes

  • e253a0d: Enhanced git -c checks in unsafe plugin.

    Thanks to @JohannesLks for identifying the issue

3.32.3

Patch Changes

  • f704208: Enhanced protocol.allow checks in allowUnsafeExtProtocol handling.

    Thanks to @CodeAnt-AI-Security for identifying the issue

3.32.2

Patch Changes

  • 8d02097: Enhanced clone unsafe switch detection.

3.32.1

Patch Changes

  • 23b070f: Fix regex for detecting unsafe clone options

    Thanks to @stevenwdv for reporting this issue.

3.32.0

Minor Changes

  • 1effd8e: Enhances the unsafe plugin to block additional cases where the -u switch may be disguised along with other single character options.

    Thanks to @JuHwiSang for identifying this as vulnerability.

Patch Changes

  • d5fd4fe: Use task runner for logging use of deprecated (already no-op) functions.

3.31.1

Patch Changes

  • a44184f: Resolve NPM publish steps

3.31.0

Minor Changes

  • 22dc93f: Custom binary plugin should support the use of ~ character, used by Windows to shorten long folder names and folder names that have spaces in them (eg: C:\Program Files might become C:\PROGRA~1).

    Thanks to @skyshineb for reporting this issue.

  • 7fbd379: Removes redundant uniqueness checks throughout the git.status parser, each file appears only once in the output from git.

    Thanks to @nathanael-ruf for contributing this change.

Patch Changes

  • c8beec9: Update simple-git documentation for cwd remove incorrect use of await

    Thank you to @siderdax for identifying this issue.

  • a0110fe: Build dependencies update

3.30.0

Minor Changes

  • bc77774: Correctly identify current branch name when using git.status in a cloned empty repo.

    Previously git.status would report the current branch name as No. Thank you to @MaddyGuthridge for identifying this issue.

3.29.0

Minor Changes

  • 240ec64: Support for absolute paths on Windows when using git.checkIngore, previously Windows would report paths with duplicate separators \\\\ between directories.

    Following this change all paths returned from git.checkIgnore will be normalized through node:path, this should have no impact on non-windows users where the git binary doesn't wrap absolute paths with quotes.

    Thanks to @Maxim-Mazurok for reporting this issue.

  • 9872f84: Support the use of git.branch(['--show-current']) to limit the branch list to only the current branch.

    Thanks to @peterbe for pointing out the use-case.

  • 5736bd8: Change to biome for lint and format

3.28.0

Minor Changes

  • 2adf47d: Allow repeating git options like {'--opt': ['value1', 'value2']}

3.27.0

Minor Changes

  • 52f767b: Add similarity to the DiffResultNameStatusFile interface used when fetching log/diff with the --name-status option.
  • 739b0d9: Diff summary includes original name of renamed files when run wiht the --name-status option.
  • bc90e7e: Fixes an issue with reporting name changes in the files array returned by git.status. Thank you @mark-codesphere for the contribution.

Patch Changes

  • 03e1c64: Resolve error in log parsing when fields have empty values.

3.26.0

Minor Changes

  • 28d545b: Upgrade build tools and typescript

3.25.0

Minor Changes

  • 0a5378d: Add support for parsing count-objects

Patch Changes

  • 4aceb15: Upgrade dependencies and build tools

3.24.0

Minor Changes

  • c355317: Enable the use of a two part custom binary

3.23.0

Minor Changes

  • 9bfdf08: Bump package manager from yarn v1 to v4

Patch Changes

  • 8a3118d: Fixed a performance issue when parsing stat diff summaries
  • 9f1a174: Update build tools and workflows for Yarn 4 compatibility

3.22.0

Minor Changes

  • df14065: add status to DiffResult when using --name-status

3.21.0

Minor Changes

  • 709d80e: Add firstCommit utility interface

Patch Changes

  • b4ab430: Add trailing callback support to git.firstCommit
  • d3f9320: chore(deps): bump @babel/traverse from 7.9.5 to 7.23.2
  • b76857f: chore(deps): bump axios from 1.1.3 to 1.6.1

3.20.0

Minor Changes

  • 2eda817: Use pathspec in git.log to allow use of previously deleted files in file argument

3.19.1

Patch Changes

  • 2ab1936: keep path splitter without path specs

3.19.0

Minor Changes

  • f702b61: Create a utility to append pathspec / file lists to tasks through the TaskOptions array/object

3.18.0

Minor Changes

  • 5100f04: Add new interface for showBuffer to allow using git show on binary files.

Patch Changes

  • f54cd0d: Examples and documentation for outputHandler

3.17.0

Minor Changes

  • a63cfc2: Timeout plugin can now be configured to ignore data on either stdOut or stdErr in the git process when determining whether to kill the spawned process.

3.16.1

Patch Changes

  • 066b228: Fix overly permissive regex in push parser

3.16.0

Minor Changes

  • 97fde2c: Support the use of -B in place of the default -b in checkout methods
  • 0a623e5: Adds vulnerability detection to prevent use of --upload-pack and --receive-pack without explicitly opting in.

Patch Changes

  • ec97a39: Include restricting the use of git push --exec with other allowUnsafePack exclusions, thanks to @stsewd for the suggestion.

3.15.1

Patch Changes

  • de570ac: Resolves an issue whereby non-strings can be passed into the config switch detector.

3.15.0

Minor Changes

  • 7746480: Disables the use of inline configuration arguments to prevent unitentionally allowing non-standard remote protocols without explicitly opting in to this practice with the new allowUnsafeProtocolOverride property having been enabled.

Patch Changes

  • 7746480: - Upgrade repo dependencies - lerna and jest
    • Include node@19 in the test matrix

3.14.1

Patch Changes

  • 5a2e7e4: Add version parsing support for non-numeric patches (including "built from source" style 1.11.GIT)

3.14.0

Minor Changes

  • 19029fc: Create the abort plugin to allow cancelling all pending and future tasks.
  • 4259b26: Add .version to return git version information, including whether the git binary is installed.

3.13.0

Minor Changes

  • 87b0d75: Increase the level of deprecation notices for use of simple-git/promise, which will be fully removed in the next major
  • d0dceda: Allow supplying just one of to/from in the options supplied to git.log

Patch Changes

  • 6b3e05c: Use shared test utilities bundle in simple-git tests, to enable consistent testing across packages in the future

3.12.0

Minor Changes

  • bfd652b: Add a new configuration option to enable trimming white-space from the response to git.raw

3.11.0

Minor Changes

  • 80d54bd: Added fields updated + deleted branch info to fetch response, closes #823

Patch Changes

  • 75dfcb4: Add prettier configuration and apply formatting throughout.

3.10.0

Minor Changes

  • 2f021e7: Support for importing as an ES module with TypeScript moduleResolution node16 or newer by adding simpleGit as a named export.

3.9.0

Minor Changes

  • a0d4eb8: Branches that have been checked out as a linked work tree will now be included in the BranchSummary output, with a linkedWorkTree property set to true in the BranchSummaryBranch.

3.8.0

Minor Changes

  • 25230cb: Support for additional log formats in diffSummary / log / stashList.

    Adds support for the --numstat, --name-only and --name-stat in addition to the existing --stat option.

Patch Changes

  • 2cfc16f: Update CI environments to run build and test in node v18, drop node v12 now out of life.
  • 13197f1: Update debug dependency to latest 4.x

3.7.1

Patch Changes

  • adb4346: Resolves issue whereby renamed files no longer appear correctly in the response to git.status.

3.7.0

Minor Changes

  • fa2c7f7: Enable the use of types when loading with module-resolution

Patch Changes

  • 3805f6b: Timeout plugin no longer keeps short lived processes alive until timeout is hit

3.6.0

Minor Changes

  • f2fc5c9: Show full commit hash in a CommitResult, prior to this change git.commit would result in a partial hash in the commit property if core.abbrev is unset or has a value under 40. Following this change the commit property will contain the full commit hash.

Patch Changes

  • c4a2a13: chore(deps): bump minimist from 1.2.5 to 1.2.6

3.5.0

Minor Changes

  • 2040de6: Resolves potential command injection vulnerability by preventing use of --upload-pack in git.clone

3.4.0

Minor Changes

  • ed412ef: Use null separators in git.status to allow for non-ascii file names

3.3.0

Minor Changes

  • d119ec4: Resolves potential command injection vulnerability by preventing use of --upload-pack in git.fetch

3.2.6

Patch Changes

  • 80651d5: Resolve issue in prePublish script

3.2.5

Patch Changes

  • ac4f38f: Show readme in published package.

3.2.4

Patch Changes

  • d35987b: Release with changesets

3.2.3

Patch Changes

  • 1e4c591: Release with changesets

3.2.2

Patch Changes

  • 497d416: Releasing with changeset

3.2.1

Patch Changes

  • 0c3085d: Releasing library through changesets

3.2.0

Minor Changes

  • b47aa19: Switch to changesets as version and changelog manager

3.1.1 (2022-01-26)

Bug Fixes

  • specify repository with directory identifier to be discoverable within monorepo (655e23c)

3.1.0 (2022-01-23)

Features

  • optionally include ignored files in StatusResult (70e6767), closes #718

3.0.4 (2022-01-23)

Bug Fixes

  • support parsing empty responses (91eb7fb), closes #713

3.0.3 (2022-01-20)

Bug Fixes

  • allow branches without labels (07a1388)
  • implement v3 deprecations (ed6d18e)
  • publish v3 as latest (5db4434)

3.0.2 (2022-01-18)

Bug Fixes

  • Backward compatibility - permit loading simple-git/promise with deprecation notice until mid-2022. (4413c47)

3.0.1 (2022-01-18)

Bug Fixes

3.0.0 (2022-01-16)

⚠ BREAKING CHANGES

  • monorepo structure (#716)

Features

2.48.0 (2021-12-01)

Features

  • StatusResult returned by git.status() should include detached state of the working copy. (#695) (f464ebe)

Bug Fixes

  • Add example for empty commit message in git.commit() (61089cb)

2.47.1 (2021-11-29)

Bug Fixes

  • Add support for node@17 in unit tests (0d3bf47)
  • Add support for node@17 in unit tests (0d3bf47)

2.47.0 (2021-10-19)

Features

2.46.0 (2021-09-29)

Features

  • completion plugin (#684) (ecb7bd6)
  • completion plugin to allow configuring when simple-git determines the git tasks to be complete. (ecb7bd6)

2.45.1 (2021-09-04)

Bug Fixes

  • support progress events in locales other than western european character sets. (8cc42f8)

2.45.0 (2021-08-27)

Features

  • Use author email field that respects mailmap (589d624)

Bug Fixes

  • getConfig always returns null despite values being present in configuration (9fd483a)

2.44.0 (2021-08-14)

Features

  • add support for getting the current value of a git configuration setting based on its name. (1d09204)

2.43.0 (2021-08-13)

Features

  • task callback types defined as single function type (b0a832c)

2.42.0 (2021-07-31)

Features

  • move log task to separate task builder (0712f86)
  • support scope argument in listConfig to return a specific scope's configuration (0685a8b)

2.41.2 (2021-07-29)

Bug Fixes

  • use literal true and false in DiffResultTextFile | DiffResultBinaryFile to aid type assertions. (8059099)

2.41.1 (2021-07-11)

Bug Fixes

  • Commit parsing should cater for file names with square brackets (ae81134)

2.41.0 (2021-07-11)

Features

  • allow setting the scope of git config add to work on the local, global or system configuration. (c7164e7)
  • allow setting the scope of git config add to work on the local, global or system configuration. (00ada06)

2.40.0 (2021-06-12)

Features

  • create the spawnOptions plugin to allow setting uid / gid owner for the spawned git child processes. (cc70220)

2.39.1 (2021-06-09)

Bug Fixes

  • add types and tests for the documented .exec API (#631) (c9207da)
  • add types and tests for the documented .exec API (c9207da)
  • updates the documentation for mergeFromTo to more closely represent its functionality (see #50 for the original requirement). (dd2244e)

2.39.0 (2021-05-13)

Features

  • git.cwd can now be configured to affect just the chain rather than root instance. (4110662)

2.38.1 (2021-05-09)

Bug Fixes

  • Export GitPluginError from the main package. (2aa7e55), closes #616

2.38.0 (2021-04-14)

Features

  • Support enabling / disabling debug logs programmatically. (#610) (c901b9c)

2.37.0 (2021-03-15)

Features

  • errorDetectionPlugin to handle creating error messages when tasks fail. (c65a419)

2.36.2 (2021-03-11)

Bug Fixes

  • Export missing SimpleGitProgressEvent (038870e), closes #601

2.36.1 (2021-03-06)

Bug Fixes

  • Documentation update for outputHandler (775d81e)
  • Support parsing git.branch where branches have carriage returns in the commit detail. (5b71012)

2.36.0 (2021-03-03)

Features

Bug Fixes

  • Fix broken link in no-response auto-generated comment (16fe73f)

2.35.2 (2021-02-23)

Bug Fixes

  • Progress plugin should request progress events for fetch as well as other common long running tasks. (ea68857)
  • upgrade debug from 4.3.1 to 4.3.2 (4b6eda8)
  • While use of the ListLogSummary type is deprecated in favour of the new LogResult, the alias type should also support the default generic DefaultLogFields to allow downstream consumers to upgrade to newer 2.x versions without the need to specify a generic. (508e602), closes #586

2.35.1 (2021-02-19)

Bug Fixes

  • Update documentation for configuring SimpleGit - options should be a Partial<SimpleGitOptions> to allow for supplying just some of its properties. (30523df), closes #580

2.35.0 (2021-02-16)

Features

2.34.2 (2021-02-07)

Bug Fixes

  • fix npm publish token definition (fb066c3)

2.34.1 (2021-02-07)

Bug Fixes

  • auto-release with release-please (0ed2d96)

2.34.0 (2021-02-06)

Features

  • refactor git push to TypeScript SimpleGitBase interface (e77ef1b)
  • refactor git push to TypeScript SimpleGitBase interface (0691e85)

2.33.0 (2021-02-06)

Features

  • automate release/changelog with release-please (3848494)
  • split the git.add into the ts SimpleGitApi (14432f9)

2.32.0 Per-command Configuration

  • Supports passing configuration arguments to the git binary (via its -c argument as a prefix to any other arguments). Eg: to supply some custom http proxy to a git pull command, use simpleGit('/some/path', { config: ['http.proxy=someproxy'] }).pull()
  • Add deprecation notice to git.silent
  • Internal Updates:
    • switch from run to runTask in git core
    • finish converting all mocks to TypeScript

2.31.0 Handle 'root' commit syntax

  • Adds a root: boolean property to the CommitResult interface representing whether the commit was a 'root' commit (which is a commit that has no parent, most commonly the first commit in a repo).

2.30.0 Restore compatibility with Node.js v10

  • Reinstates native support for node.js v10 by removing use of ES6 constructs

2.29.0 Update TypeScript response type for git.mergeFromTo

  • Update type definition for git.mergeFromTo to be the MergeResult returned when using the more generic git.merge method. Thanks to @ofirelias for the pull request.

2.28.0 Add support for git apply & TypeScript Integration Tests

  • Adds support for git.applyPatch to apply patches generated in a git diff to the working index, TypeScript consumers can make use of the ApplyOptions type definition to make use of strong types for the supported options. Thanks to @andreterron for the pull request.

  • Integration tests converted to TypeScript to ensure type safety across all tests.

2.27.0 Included staged delete/modify in StatusResult staged array

  • Update the git.status parser to account for staged deleted/modified files and staged files with subsequent modifications meaning a status of:
    • RM old -> new will now appear in renamed and new will also appear in modified
    • D file will now appear in both deleted and staged where D file would only appear in deleted

2.26.0 Fix error when using git.log with callback

  • Resolves an issue whereby using git.log with a callback (or awaiting the promise created from the now deprecated simple-git/promise import) would fail to return the response to the caller.

2.25.0 TypeScript Types & Unit Tests, Commit Parsing

  • See Legacy Node Versions for details of how to use simple-git with node.js versions 11 and below.
  • To help keep the TypeScript definitions in line with functionality, unit tests are now written in TypeScript.
  • When using git.commit, the first argument must be a string or array of strings. Passing another data type has long been considered an error, but now a deprecation warning will be shown in the log and will be switched to an error in version 3.
  • Fixes an issue in git.commit whereby a commit that included only deleted lines would be parsed as though the deletions were inclusions.

2.24.0 Types updated

  • pull, push and pushTags parameter types updated to match new functionality and tests switched to TypeScript to ensure they are kept in sync

2.23.0 update debug dependency & master -> main

  • Upgrade debug dependency and remove use of now deprecated debug().destroy()
  • Renames the default source branch from master to main

2.22.0 add git.hashObject interface

  • Adds support for git hash-object FILE and git hash-object -w FILE with new interface git.hashObject(...), with thanks to @MiOnim

2.21.0 add string[] to LogOptions type

  • Adds string[] to the set of types supported as options for git.log
  • Fix readme typos

2.20.1 Bug-fix: LogOptions type definition

  • LogOptions should be intersection rather than union types

2.19.0 - Upgrade task option filters

  • move the command/task option processing function to TypeScript

2.18.0 - Upgrade Clone / Mirror tasks

  • 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.

2.17.0 - Add remote message parsing to git pull

  • 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.

2.16.0 - Upgrade Move task

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

2.15.0 - Task parsers automatically have access to stdErr as well as stdOut

  • 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

2.14.0 - Bug fix: git.checkoutBranch fails to pass commands to git child process

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

2.13.2 - PushResult to expose all non-empty remote messages

  • 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).

2.13.1 - Add support for parsing GitLab Pull Request Url Message

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

2.13.0 - Upgraded Pull & Merge and parser for Push

  • .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

2.12.0 - Bug fix: chaining onto / async awaiting git.tags failed

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

2.11.0 - Parallel / concurrent tasks, fresh repo status parser & bug-fix in checkoutLocalBranch

  • 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

2.10.0 - trailing options in checkout, init, status, reset & bug-fix awaiting a non-task

  • 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));

2.9.0 - checkIsRepo, rev-parse

  • .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

2.8.0 - Support for default import in TS without use of esModuleInterop

  • 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.

2.7.0 - Output Handler and logging

  • 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').

2.6.0 - Native Promises, Typed Errors, TypeScript Importing, Git.clean and Git.raw

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.

2.5.0 - Git.remote

  • all git.remote related functions converted to TypeScript

2.4.0 - Git.subModule

  • all git.subModule related functions converted to TypeScript

2.3.0 - Git.config

  • 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

2.2.0 - Git.branch

  • 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

2.1.0 - Git.tag

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

2.0.0 - Incremental switch to TypeScript and rewritten task execution

  • 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.

v1 and below

Please see the historical changelog;