Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/tasks/report"

Index

Functions

generateReport

  • generateReport(api: Api, label: string, template: string): Promise<string>
  • Generate a report

    Parameters

    • api: Api

      GitLab API to make requests with

    • label: string

      Label to generate report for

    • template: string

      Template to generate report with

    Returns Promise<string>

getIssueBranches

  • getIssueBranches(api: Api, projects: Project[]): Promise<object>
  • Get IDs of issues with branches for projects

    Parameters

    • api: Api

      GitLab API To make requests with

    • projects: Project[]

      List of projects

    Returns Promise<object>

getIssues

  • getIssues(api: Api, label: string, groups: number[]): Promise<Issue[]>
  • Get issues from all groups with a specific milestone

    Parameters

    • api: Api

      GitLab API to make requests with

    • label: string

      Label to filter by

    • groups: number[]

      List of groups to get issues for

    Returns Promise<Issue[]>

getIssuesGroupedByAssignees

  • Get issues grouped by assignees

    Parameters

    • api: Api

      GitLab API to make requests with

    • label: string

      Label to generate report for

    Returns Promise<AssigneeWithIssues[]>

getMergeRequestUrls

  • Get merge request URLs from given data

    Parameters

    • projectMergeRequests: MergeRequestsForProjects

      Merge requests data (object containing array of objects)

    • projectId: number

      Project ID to get data about merge requests for

    • issueIid: number

      Issue IID in certain project (relative ID, and not issue's GitLab API ID)

    Returns string[]

getMergeRequests

  • Get a list of merge requests for projects

    Parameters

    • api: Api

      GitLab API to make requests with

    • projects: Project[]

      List of projects

    Returns Promise<MergeRequestsForProjects>

getNextMeetingDay

  • getNextMeetingDay(): string
  • Get next meeting day

    Returns string

issueStateIsOpenedOrClosed

  • issueStateIsOpenedOrClosed(state: IssueState): boolean
  • Check if issue state is opened or closed

    Parameters

    Returns boolean

report

  • report(api: Api, label: string): Promise<void>
  • Generate a markdown report

    Parameters

    • api: Api

      GitLab API to make requests with

    • label: string

      Label to generate report for

    Returns Promise<void>

Generated using TypeDoc