local-repository-provider

repository provider using local (native) git commands


Keywords
git, repository-provider
License
BSD-2-Clause
Install
npm install local-repository-provider@3.1.7

Documentation

npm Greenkeeper semantic-release styled with prettier Build Status codecov.io Coverage Status Known Vulnerabilities GitHub Issues Stories in Ready Dependency Status devDependency Status docs XO code style downloads Commitizen friendly

local-repository-provider

repository provider using local (native) git commands

API

Table of Contents

LocalProvider

Extends Provider

Provider using native git executable

newWorkspacePath

Generate path for a new workspace For the livetime of the provider always genrate new names

Returns string path

repository

using provider workspace and number of repositories to create repository workspace

Parameters

optionsFromEnvironment

  • GIT_CLONE_OPTIONS

Parameters

  • env

defaultOptions

Default configuration options

  • workspace

Returns Object

LocalRepository

Extends Repository

Properties

_initialize

exec git clone or git pull

Parameters

refId

Get sha of a ref Calls

git show-ref <ref>

Parameters

Returns string sha of the ref

workspace

workspace directory.

Returns string

LocalBranch

Extends Branch

Properties

writeContent

writes content into the branch

Parameters

Returns Promise<Array<Content>> written content

commit

Excutes:

  • writes all updates into the workspace
  • git add
  • git commit
  • git push

Parameters

  • message string commit message
  • updates Array<Content> file content to be commited
  • options Object

list

Search for patch in the branch

Parameters

  • matchingPatterns Array<string> (optional, default ["**/.*","**/*"])

Returns Content matching branch path names

install

With npm do:

npm install local-repository-provider

license

BSD-2-Clause