Module "internal/env/gitInfo"

Index

Interfaces

GitInformation

Functions

Functions

cleanGitUrl

cleanGitUrl(url: string): string

- Defined in lib/internal/env/gitInfo.ts:89
Parameters
- url: string
Returns string

obtainGitInfo

obtainGitInfo(directory: string): Promise<GitInformation>

- Defined in lib/internal/env/gitInfo.ts:13
Return Git remote origin URL, branch, and sha for provided directory. If provided directory is not a Git repository, empty strings will be returned for the repository, branch, and sha.

Parameters
- directory: string
  
  path to local Git repository
Returns Promise<GitInformation>

Git URL, branch, and sha

Generated using TypeDoc