Welcome to Open Source Mediumroast for GitHub.

Products organizations must build robust product plans from competitive and customer interactions everyone can see, use, and reference. Therefore, Mediumroast for GitHub intends to help Products oranizations construct an active interactions repository close to the action of development and issue management in GitHub.

Notice: You can review the GitHub Page Version rather than the repository version of this documentation, but the screencasts of several of the CLI tutorials will not display.

Installation and configuration

Mediumroast for GitHub includes a GitHub Application, a Command Line Interface, and a Software Development Kit. The following steps show you how to install the App and the CLI with SDK.

Preinstallation requirements

1. A GitHub organization, please
2. Permissions in your GitHub organization to install a GitHub application.
3. Access to a command line terminal on Linux or MacOS.
4. Node.js installed, ideally globally for all users.
5. NPM installed, ideally globally for all users.

Step 1 - Install the GitHub App

Browse to the Mediumroast for GitHub GitHub Application and:

1. Click install,
2. Choose the location for the installation, usually your organization,
3. Confirm the requested permissions, and
4. Browse to your organization's Settings > Third-Party Access > GitHub Apps and confirm that Mediumroast for GitHub is installed.

Step 2 - Install mediumroast_js

This package mediumroast_js can be installed and removed via npm, several ways to install follow.

For Linux and MacOS

Assuming the preinstallation requirements, installation of node.js and npm, are met please one one of the following.

1. Global installation for all users: sudo npm i -g mediumroast_js
2. Local installation for a developer or single user: npm i mediumroast_js

For WinOS

Coming soon.

Step 3 - Setup the CLI

Before you can use the Mediumroast for GitHub CLI the environment must be setup. With the CLI installed please run mrcli setup to start the setup process, note there's a video of the setup process in CLI README.

What's provided

Running mrcli setup creates a repository in your oganization called <organization_name>_discovery for all interactions and objects, creates two intitial companies, and installs two GitHub Actions to control the number of branches and provide some basic out of the box reporting -- see example screenshot below.

Warning

Since Mediumroast for GitHub creates a regular repository you can interact with it as normal, but doing so is not recommended. If you interact with the repository, in regular ways, this could result in Mediumroast for GitHub becoming inoperable. There are cases where it may become necessary to directly work with the repository, but that should be rare.

Example screenshot of in repository companies report

Issues

If you detect a problem or want to suggest an improvement open an issue and we will work with you to resolve or respond.