isabella232 / project-monitor-helper

A Ruby script that automatically generates the projects.json required by Project Monitor

Description

Project Monitor Helper is a Ruby utility that generates the projects.json required by Project Monitor.

It uses the GitHub API to find all repos within an organization that have a .travis.yml.

Setup

Prerequisites

On a Mac, you'll need a development environment that includes Git, Homebrew, Ruby, RVM (or rbenv), and Bundler. The easiest way to make sure you have all the prerequisite tools is to run the 18F laptop script.

Install

script/bootstrap

Set the GitHub environment variables

1. Generate a new GitHub access token
2. In the .env file, set GITHUB_ACCESS_TOKEN to the token you generated.
3. In .env, set GITHUB_ORG to your organization's name.

Run the script

dotenv ruby projects_generator.rb

This will generate a projects.json in the root directory.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.