VcsConfig

Configures the version control system (VCS).

Index

Properties

• defaultBranch
• hookFormat
• hooks
• manager
• provider
• remoteCandidates
• syncHooks

Properties

optionaldefaultBranch

defaultBranch?: string = ```ts 'master' ```

The default branch / base.

hookFormat

hookFormat: VcsHookFormat = VcsHookFormat

The format to use for generated VCS hook files.

hooks

hooks: Record<string, string[]>

A mapping of hooks to commands to run when the hook is triggered.

manager

manager: git = ```ts 'git' ```

The VCS client being utilized by the repository.

provider

provider: VcsProvider = VcsProvider

The upstream version control provider, where the repository source code is stored.

optionalremoteCandidates

remoteCandidates?: string[]

List of remote's in which to compare branches against.

syncHooks

syncHooks: boolean

Generates hooks and scripts based on the hooks setting.