Skip to content

naomiajacobs/googleSheetsGithubPRVisualization

Repository files navigation

Google Sheets Github Pull Request Visualization

Build Status

This repo contains the code and instructions to add a visualization of your team's branch strategy to a tab in a Google Sheet.

Visualization Screenshot

To use this code:

  1. Make a Google Sheet
  2. Pick a target tab in the sheet that you want the visualization to appear on.
  3. Navigate to Tools > Script Editor to open the Google App Scripts editor.
  4. Copy the code snippet below and paste it into your script. Fill in the variables with your information.
// FILL THESE IN // The name of the Google Sheets menu tab you want the script to go under var tabName = YOUR_TAB_NAME // The name of the menu item in the menu tab var menuName = YOUR_MENU_NAME // The name of the github organization your repo is nested under var githubOrg = YOUR_GITHUB_ORGANIZATION_NAME // The name of the repo that contains your milestone (may need to try lowercasing this) var repoName = YOUR_REPO_NAME // The milestone whose PRs you want to visualize var milestoneNumber = YOUR_MILESTONE_NUMBER // Generated Github token - you can get one in your Github settings var token = YOUR_GITHUB_TOKEN // YOU DON'T NEED TO TOUCH ANYTHING BELOW THIS LINE var prFetcherURL = "https://raw.githubusercontent.com/naomiajacobs/googleSheetsGithubPRVisualization/master/pullRequestTree.js" var rendererURL = "https://raw.githubusercontent.com/naomiajacobs/googleSheetsGithubPRVisualization/master/googleSheetsRenderer.js" var githubPRs = eval(UrlFetchApp.fetch(prFetcherURL).getContentText()) var renderer = eval(UrlFetchApp.fetch(rendererURL).getContentText()) function onOpen() { this.spreadsheet = SpreadsheetApp.getActiveSpreadsheet() var entries = [{ name : tabName, functionName : "fetchBranchesAndRender" }] this.spreadsheet.addMenu(menuName, entries) } function fetchBranchesAndRender() { var options = { orgName: githubOrg, repoName: repoName, milestoneNumber: milestoneNumber, token: token } var tree = githubPRs.pullRequestTree(options) renderer.renderTree(tree, tabName) }
  1. Add a project trigger that runs onOpen whenever a user opens the spreadsheet. Trigger Screenshot
  2. Save the script and refresh your google sheet. You should see a new menu item with the 'Update Branches' option. Click that, and you should see your visualization populate the target tab.

Developed with @jasonwc