This is a test project that is not supported and needs specific fine-tuning to be compatible to a given use-case.

This GitHub repository offers a script with similar functionalities, go check it out!

GitHub projects (and issues) are extensively used by developers. However, GitHub lacks feature dedicated to engineering management and organization such as building metrics from the project data (burndown charts, workload by issue type, etc.)

This project is a first tentative to build a relational database containing items from a GitHub project, so that this data can then be explored and used by engineering managers.

To ease this experimentation, the database is actually a Google Sheet file and the targeted runtime environment is Google Apps Script: Once the data is in Google Sheet, dashboards and metrics can easily be built ; hence this project mostly focuses on the interface with the GitHub GraphQL API.

flowchart
    GAS[Google Apps Script] -->|Queries| GH[GitHub GraphQL]
    GH --> |Answers| GAS
    GAS --> |Stores| GS[Google Sheet]
    GS --> |Displays| EM[Engineering Manager]

• Add a file to the project, containing a GitHub token to your account, as follows:

function GetGithubToken(){ return GITHUB_TOKEN ; }

• Replace every occurence of AgentAGadge by your GitHub login in src/api/GitHub_queries.js

Then you should adapt the various mapping done in the code to the structure of your GitHub project and to the database structure you want:

• Change the properties of the ParsedIssue class (src/model/ParsedIssue.js) to match the fields of your GitHub project.

• Change the PROJECT_FIELD_NAME_ constants defined in src/model/ProjectConfiguration.js (and everywhere they are used) to match the fields of your GitHub project.

• Change the COLUMN_ constants defined in src/model/db/sheetDB.js (and everywhere they are used) to match the columns you want in your Google sheet database.

• Create a sheet names GitHub database in the Google Sheet file you want to use, and make it active.

• Change the projectNumber to identify the project of your user you want to work on in src/main.js

You can then deploy the project into Google Apps Script. It is recommended to use clasp to deploy code on Google Apps Script. See here.

Run CreateGSFromGH from src/main.js in Google Apps Script.

You should see the sheet populated with items from your GitHub project.

CreateGSFromGH from src/main.js performs the following actions:

• initDB(): Create the sheetDB (write headers in the sheet)
• syncDB(): Retrieve all the needed data from GitHub GraphQL and adapt it for the sheetDB.

syncDB is decomposed the following steps:

• syncGHItemsToDB(): Retrieve all the project items from GitHub, parse them and store them.

flowchart
    GHQ[GitHub_queries] --> |provides query body| GHAPI[GitHub_API]
    GHAPI -->|Queries| GH(GitHub GraphQL)
    GH --> |Answers project items| GHAPI
    GHAPI --> |Pass project items| GSDB[SheetDB]
    GSDB --> |Inserts items| GS[Google Sheet]

Those items have some non human-readable values (IDs instead of names, for GitHub users for instance). It is therefore needed to clean this data so that it can be easily used later on.

• syncGHFieldsToDB(): Retrieve all the project configuration properties and users related to the project, and replaces the non-readable values previously stored by the corresponding slug.

flowchart
    GHQ[GitHub_queries] --> |provides query body| GHAPI[GitHub_API]
    GHAPI -->|Queries| GH(GitHub GraphQL)
    GH --> |Answers project configuration| GHAPI
    GHAPI --> |Pass project configuration| GSDB[SheetDB]
    GSDB --> |Replace IDs with slugs| GS[Google Sheet]