Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GitInformation

Return the gather information from the repository

Hierarchy

  • GitInformation

Properties

branch: string

Current branch

git symbolic-ref --short HEAD

commit: string

Current commit reference

git rev-parse HEAD

short: string

Current commit short reference

git rev-parse --short HEAD

tag: string

Current tag name that match the package version

tags: string[]

Return all tags that point to the current HEAD

git tag --points-at HEAD

version: string

Current version as return by package.json with auto snapshot

If the version return by package is not in the current tags, the version is incremented to the next patch version with a +{date}

Example:

with package.json version = "1.1.0" name = "mypackage" if a tag "v1.1.0" or "mypackage@1.1.0" then version = "1.1.0" else version = "1.1.1+20201110163014178"

Generated using TypeDoc