Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GitRepositoryContext

Represents the git repository context.

Hierarchy

  • GitRepositoryContext

Index

Properties

Properties

Optional commit

commit?: string

Commit keyword in the url.

DEFAULT: 'commits'

Optional date

date?: string

Default to formatted ('yyyy-mm-dd') today's date. dateformat is used for formatting the date. If version is found in the last commit, committerDate will overwrite this.

Optional host

host?: string

The hosting website. Eg: 'https://github.com' or 'https://bitbucket.org'.

Optional issue

issue?: string

Issue or pull request keyword.

DEFAULT: 'issues'

Optional owner

owner?: string

The owner of the repository. Eg: 'stevemao'.

Optional repoUrl

repoUrl?: string

The whole repository url. Eg: 'https://github.com/gitex-flow/gitex-flow-node'. The should be used as a fallback when context.repository doesn't exist.

Optional repository

repository?: string

The repository name on host. Eg: 'gitex-flow-node'.

Optional title

title?: string

Title of the current version.

Optional version

version?: string

Version number of the up-coming release. If version is found in the last commit before generating logs, it will be overwritten.