Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NewGitWhoDis

This Bot Action class analyzes the name of the author of the GitLab Merge Request and determines what, if any, feedback to provide to user.

Hierarchy

  • NewGitWhoDis

Index

Properties

Methods

Properties

Static Readonly badIcon

badIcon: ":loudspeaker:" = `:loudspeaker:`

Static Readonly badNote

badNote: "it's really hard to see who you are! Would you please make your Git account names human readable?" = `it's really hard to see who you are! Would you please make your Git account names human readable?`

Static Readonly botActionName

botActionName: "NewGitWhoDis" = "NewGitWhoDis"

Static Readonly hashtag

hashtag: "[#NewGitWhoDis](https://github.com/Cigna/GitRDoneBot#6-new-git-who-dis)" = `[#NewGitWhoDis](https://github.com/Cigna/GitRDoneBot#6-new-git-who-dis)`

Methods

Static analyze

  • remarks

    this function never requires an API call

    Parameters

    • authorName: string

      the name of the GitLab user who authored the Merge Request

    Returns Promise<BotActionResponse>

    data about properties calculated by New Git Who Dis analysis

Static Private authorNameIsNotLanId

  • authorNameIsNotLanId(authorName: string): boolean

Static buildSuccessfulAction

  • Invoked when Bot Action analysis was successful. Constructs a BotAction object containing goodGitPractice and conditional feedback message.

    Parameters

    • authorName: string
    • goodGitPractice: boolean

      represents whether or not the Merge Request event meets the criteria for good New Git Who Dis practice

    Returns SuccessfulBotAction

    SuccessfulBotActionWithMessage instance containing feedback for user. If no feedback is warranted, an instance of SuccessfulBotActionWithNothingToSay is returned.

Generated using TypeDoc