Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/issues"

Gathering the issue comments and add these comments to the relevant issues on github

See collect_resolutions for the essential entry point.

Index

Classes

Variables

Functions

Variables

Const res_regex

res_regex: RegExp = /> \*\*\*Resolution #([0-9]+):(.*$)/

Regular expression to extract the resolution number.

internal

Functions

collect_issue_comments

  • Collect all the issues. The function calls out, for each minute file, to the get_issue_comments function, and then add these comments to the issues themselves, using the methods provided in the IssueDiscussion instances.

    async

    Parameters

    • gh_credentials: Credentials

      the user's Github credentials

    • file_names: string[]

      List of the minute file names, i.e., the base name of the minute file in its repository

    • get_data: GetDataCallback

      A function returning the markdown content of the minutes in a Promise. The function itself either uses the local file system read or a fetch to the repository, depending on whether this function is called for a local or a github repository.

    Returns Promise<void>

    • List of resolutions

get_issue_comments

  • Extract the discussions around issues.

    The process looks for section (or subsection) headings; if those headings include a reference to an issue (or PR) a new IssueDiscussion is initiated. This means collecting the markdown lines until the next (sub)heading, or an explicit line if the form:

    <!-- issue - -->

    The result is a list of issue discussion objects, each with its own associated issues; these can be used to generate the issue comments themselves.

    Parameters

    • github_cache: GithubCache

      the important item is to extract the OAUth token of the user

    • minutes: string

      the minutes as a series of markdown lines.

    Returns IssueDiscussion[]