Index > git

Namespace: git

Utilities for handling Git repositories.

Interfaces

Author

A Git author

Properties

PropertyType
namestring

Variables

GRIT_APP_BOT_AUTHOR

const GRIT_APP_BOT_AUTHOR: Author

The Grit bot

Functions

isGritBotAuthor

isGritBotAuthor(author): boolean

Check if a given author is the Grit bot This is useful for ensuring workflows don't get stuck in a loop

Parameters

ParameterType
authorstring

Returns

boolean


makeEmail

makeEmail(author): string

Generate the email for a given author Currently this is just the author's name + @users.noreply.github.com

Parameters

ParameterType
authorAuthor

Returns

string


Generated using TypeDoc and typedoc-plugin-markdown