Bot Architecture

January 18, 2021 ยท View on GitHub

Structure:

  • /src/tasks/processIssueComment is the root for incoming comments with the following sub components:
  • CommentReply, deals with responding to a comment
  • ContentFiles, or readmes files that will be re-generated and updated with the table
  • OptionsConfig, the configuration for the bot, and the list of contributions
  • Repository, used by ContentFiles and OptionsConfig for getting files, updating files, creating branches and pull requests
  • utils/parse-comment used for determining the intention of the users comment

Uses Probot for incoming events, and communicating/authenticating with github. Probot docs, GitHub octokit/restjs API docs