Pull Requests Overview Tool¶
This tool consists of a Google Sheets file, and accompanying Google Scripts. The sheets involved are:
- Pull requests overview
- GitHub teams
- Reviewers
- Unavailable reviewers
Purpose¶
This tool is meant to give an overview of all active pull requests in the GIRAF GitHub repositories. It is also used to assign reviewers to pull requests, and to post the checklists found here alongside them.
Setup¶
The tool needs to be setup with data about the current GIRAF team in order to function.
The data is entered into some of the sheets, and the Google Scripts found at
Tools>Script Editor in the menus bar.
The GitHub teams sheet must contain data about the current GIRAF team groups and their roles regarding process and PO.
The Reviewers sheet must contain the GitHub account names of all members of the current GIRAF team. This data can be filled in with the Update button at the top of the sheet.
The Unavailable reviewers sheet must contain the GitHub account names of any members who are currently unavailable. They will be exempt from being assigned as reviewers as long as they are listed here.
In the API.gs file found with the script editor, the SEMESTER_START_DATE needs
to be updated to the start date of the current GIRAF team's semester. In the same
file, the ACCESS_TOKEN needs to be updated with a GitHub access token from one
of the team members. An access token can be generated here.
Usage¶
The tool is used with the two buttons in the Pull request overview sheet.
The Update button updates the overview with information about active pull requests.
It has the getPullRequestsOverview script assigned to it, which is found in the
PullRequestOverview.gs file.
The Add Reviewers button adds reviewers to the pull requests that currently have
no reviewers assigned. It has the addReviewersToPullRequests script assigned
to it, which is found in the PullRequestOverview.gs file.
