https://github.com/blond/git-retry
:repeat: fault-tolerant git retry wrapper
https://github.com/blond/git-retry
git retry
Last synced: 3 months ago
JSON representation
:repeat: fault-tolerant git retry wrapper
- Host: GitHub
- URL: https://github.com/blond/git-retry
- Owner: blond
- License: mit
- Created: 2018-03-30T22:51:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-02T10:26:31.000Z (about 7 years ago)
- Last Synced: 2025-02-02T00:44:19.902Z (5 months ago)
- Topics: git, retry
- Language: TypeScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
git-retry
=========
[![NPM Status][npm-img]][npm]
[![Travis Status][test-img]][travis]
[![Windows Status][appveyor-img]][appveyor]
[![Coverage Status][coverage-img]][coveralls]
[![Dependency Status][david-img]][david]
[npm]: https://www.npmjs.org/package/git-retry
[npm-img]: https://img.shields.io/npm/v/git-retry.svg
[travis]: https://travis-ci.org/blond/git-retry
[test-img]: https://img.shields.io/travis/blond/git-retry/master.svg?label=tests
[appveyor]: https://ci.appveyor.com/project/blond/git-retry
[appveyor-img]: https://img.shields.io/appveyor/ci/blond/git-retry/master.svg?label=windows
[coveralls]: https://coveralls.io/r/blond/git-retry
[coverage-img]: https://img.shields.io/coveralls/blond/git-retry/master.svg
[david]: https://david-dm.org/blond/git-retry
[david-img]: https://img.shields.io/david/blond/git-retry/master.svg
`git-retry` is a bootstrap that wraps a standard git command execution in a fault-tolerant retry wrapper.
If a retry succeeds, the info of successful attempt is returned. Otherwise, the rejects that occured most frequently. The wrapper is aware of git-specific failure conditions and will only consider retrying if a given failure can be linked to such a condition.
Install
-------
```
$ npm install --save git-retry
```
Usage
-----
```js
const gitRetry = require('git-retry');
gitRetry('git', ['pull', '--all'], { retries: 5 }, { shell: true })
.then(({ stdout, stderr }) => console.log(`git pulled, see log: ${stdout}`))
.catch(() => console.error('git failed'));
```
API
---
### gitRetry([bin, ]args[, retryOptions[, execOptions]])
Executes git command.
#### bin
Type: `string`
Default: `git`
The name or path of the executable file to run `git`.
#### args
Type: `string[]`
Arguments of git command.
#### retryOptions
Type: `Object`
Options are passed to the [`retry`](https://github.com/tim-kos/node-retry#retryoperationoptions) module.
#### execOptions
Type: `Object`
Options are passed to the [`execa`](https://github.com/sindresorhus/execa#options) module.
License
-------
MIT © [Andrew Abramov](https://github.com/blond)