External module utils/git

Git commands using the Git CLI.

This module provides some Git commands by wrapping the CLI. It runs the commands by generating the CLI options and spawning a sub-process.

Index

Interfaces

Functions

Functions

assertCleanBranch

assertCleanBranch(allowedBranches: string[]): Promise<void>

- Defined in src/lib/utils/git.ts:24
Parameters
- allowedBranches: string[]
Returns Promise<void>

execGit

execGit(cmd: string, args?: string[], options?: SpawnOptions): Promise<SpawnResult>

- Defined in src/lib/utils/git.ts:16
Parameters
- cmd: string
- Default value args: string[] = []
- Optional options: SpawnOptions
Returns Promise<SpawnResult>

getHeadHash

getHeadHash(): Promise<string>

- Defined in src/lib/utils/git.ts:47
Get the hash of the HEAD commit.

Returns Promise<string>

The hash of the HEAD commit.

gitAdd

gitAdd(options: GitAddOptions): Promise<void>

- Defined in src/lib/utils/git.ts:92
Clone a repository into a new directory

Parameters
- options: GitAddOptions
Returns Promise<void>

gitClone

gitClone(options: GitCloneOptions): Promise<void>

- Defined in src/lib/utils/git.ts:65
Clone a repository into a new directory

Parameters
- options: GitCloneOptions
Returns Promise<void>

gitCommit

gitCommit(options: GitCommitOptions): Promise<void>

- Defined in src/lib/utils/git.ts:106
Parameters
- options: GitCommitOptions
Returns Promise<void>

gitPush

gitPush(options: GitPushOptions): Promise<void>

- Defined in src/lib/utils/git.ts:122
Parameters
- options: GitPushOptions
Returns Promise<void>

tagExists

tagExists(tag: string): Promise<boolean>

- Defined in src/lib/utils/git.ts:51
Parameters
- tag: string
Returns Promise<boolean>

Generated using TypeDoc