github-automation

Automation tools for Design Control Procedures and Documents with Github Integration

Installation

git clone https://github.com/max-mobility/github-automation
cd github-automation
npm install # installs github-api, underscore, argparse

Usage

Right now it just scrapes and filters the repository's issues based on provided arugments.

$ node index.js --help
usage: index.js [-h] [-v] [-r REPO] [-o OWNER] [-s {all,open,closed}]
                [-p PATTERN]
                

Github Automation

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -r REPO, --repo REPO  Repository to scrape
  -o OWNER, --owner OWNER
                        Owner of the repository
  -s {all,open,closed}, --state {all,open,closed}
                        The state of the issues
  -p PATTERN, --pattern PATTERN
                        A pattern that the labels on the issues should match

Which will produce a table that is properly formatted into a PDF at ${date}.${pattern}.pdf and HTML at ${date}.${pattern}.html.

The PDF file will be automatically opened by the default pdf viewer on the system.

Example table produced:

Software Requirement	Github Issues	Creation	Completion
requirement-SRS-1-A	6: Implement bluetooth connectivity to PT and SD	2018-03-05	2018-07-02
requirement-SRS-2-A	6: Implement bluetooth connectivity to PT and SD	2018-03-05	2018-07-02
requirement-SRS-3-A	6: Implement bluetooth connectivity to PT and SD	2018-03-05	2018-07-02
requirement-SRS-4-A	6: Implement bluetooth connectivity to PT and SD	2018-03-05	2018-07-02
requirement-SRS-5-A	6: Implement bluetooth connectivity to PT and SD	2018-03-05	2018-07-02
requirement-SRS-6-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
requirement-SRS-7-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
requirement-SRS-8-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-9-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-10-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
requirement-SRS-11-A	4: Set up Kinvey integration	2018-03-05	2018-03-27
requirement-SRS-12-A	29: Flesh out the UI and refactor the dashboard	2018-04-16	2018-04-16
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-13-A	29: Flesh out the UI and refactor the dashboard	2018-04-16	2018-04-16
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-14-A	2: Stub out top-level menu pages	2018-02-05	2018-03-05
	1: Stub out Evaluation pages	2018-02-05	2018-06-18
requirement-SRS-15-A	1: Stub out Evaluation pages	2018-02-05	2018-06-18
requirement-SRS-16-A	33: Add PT connectivity and interfaces to Trial pages	2018-05-14	2018-05-22
	1: Stub out Evaluation pages	2018-02-05	2018-06-18
requirement-SRS-17-A	2: Stub out top-level menu pages	2018-02-05	2018-03-05
	1: Stub out Evaluation pages	2018-02-05	2018-06-18
requirement-SRS-18-A	39: LMN Generation	2018-05-22	2018-06-06
	1: Stub out Evaluation pages	2018-02-05	2018-06-18
requirement-SRS-19-A	17: OTA Page Implementation and Use Cases	2018-03-27	2018-06-18
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-20-A	17: OTA Page Implementation and Use Cases	2018-03-27	2018-06-18
requirement-SRS-21-A	13: Integrate barcode scanner for scanning SmartDrives and PushTrackers	2018-03-09	2018-06-26
	2: Stub out top-level menu pages	2018-02-05	2018-03-05
requirement-SRS-22-A	38: Set up ngx-translate for NS app	2018-05-16	2018-05-16
	14: Translation functionality	2018-03-09	2018-07-11
requirement-SRS-23-A	118: Release beta onto iOS App Store and Google Play Store	2018-07-16	Invalid date
requirement-SRS-24-A	5: Push Notifications from Kinvey	2018-03-05	Invalid date
requirement-SRS-25-A	5: Push Notifications from Kinvey	2018-03-05	Invalid date
requirement-SRS-26-A	5: Push Notifications from Kinvey	2018-03-05	Invalid date