Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GithubRepoProcessing

Repository management for a (remote) github repository. The necessary information are gathered via the Github API.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

credentials

credentials: Credentials

Github credentials, necessary for some steps. Set at initialization time

list_of_minutes

list_of_minutes: string[] = []

List of minute file names. This is set in the relevant subclasses.

repo

repo: Repo

The repository being managed. Set at initialization time

Methods

handle_one_repo

  • handle_one_repo(): Promise<void>

process_minutes

  • Processing the information for a single repository. This is mostly a shell around the real work done in other modules. The function

    1. filters out the minutes that have not yet been handled (this information is part of current)
    2. goes through the processing (resolution gathering, issues, etc)
    3. updates the value of current and uploads it to the repository

    The two callback functions are instantiated in the subclasses to either read/write from/to a local directory or the (remove) github repository.

    Parameters

    • current: MinuteProcessing

      collection of information related to the current status for the repository

    • get_data: GetDataCallback

      callback function used to get to the content of the minute for a single file

    • write_data: WriteDataCallback

      callback function used to store the new content on the repository

    Returns Promise<void>