Function: gitRevisionOf()

Documentation / @wtf/project-typedoc / config / gitRevisionOf

function gitRevisionOf(root, sources): string;

Defined in: packages/project-typedoc/src/config.ts:115

The git revision each source links to:

1. --gitRevision <ref> in the arguments of the run, as a build names the ref it links to;
2. else the commit of HEAD of the repo at root; of a repo of no commit yet, its branch, and main where git names none.

Parameters

Parameter	Type	Description
root	string	The repo’s root.
sources	RevisionSources	The arguments of the run, and what runs git.

Returns

string

The revision.