GitInformation
Interface: GitInformation
Defined in: compiler/src/definition.ts:905
Return the gather information from the repository
Mermaid
Make TypeDoc easy to use with mermaid.js graph TB mermaid.js --> TypeDoc;
Properties
branch
branch:
string
Defined in: compiler/src/definition.ts:917
Current branch
git symbolic-ref --short HEAD
commit
commit:
string
Defined in: compiler/src/definition.ts:911
Current commit reference
git rev-parse HEAD
short
short:
string
Defined in: compiler/src/definition.ts:923
Current commit short reference
git rev-parse --short HEAD
tag
tag:
string
Defined in: compiler/src/definition.ts:927
Current tag name that match the package version
tags
tags:
string[]
Defined in: compiler/src/definition.ts:933
Return all tags that point to the current HEAD
git tag --points-at HEAD
version
version:
string
Defined in: compiler/src/definition.ts:946
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"