Connecting to GitHub

Note that this is a paid feature.

It can be a pain to get your historical data into that comma-separated list of tasks completed per week. Four weeks is pretty straight-forward, but if you’re looking back 6 months or more, it can get tedious. Monte can simplify this process.

How it works

Monte uses the GitHub API to pull in the historical data for the project. It will then calculate how many tasks were completed per week and how many tasks are remaining. This data is then formatted and sent to Monte where it is used to generate the forecast chart. After initial setup, you’ll be able to pull the latest information from GitHub with the click of a button.

Setup

First, you’ll need to create the connection to GitHub.

  1. Click on the top-right 3-dot menu and select Project Settings.
  2. Click on Connect to GitHub.

You’ll be redirected to GitHub to authenticate and authorize Monte to access your GitHub data.

  1. Authorize Monte to access your GitHub data.

You’ll then be redirected back to Monte and the GitHub connection will be setup.

Basic Configuration

Now let’s configure the connection.

  1. Select the GitHub Organization you want to use.
  2. Search and select the GitHub Repository you want to pull data from.
  3. Optionally, you can set the Since Date to pull in data from a certain date in the past. Otherwise, it’ll pull in all data from that project’s history.
  4. Click Save.
  5. Back in the main Monte view, click the Update Data button and you’ll see the information loaded up.

Now you can update the data with the Update Data button anytime you want.

Advanced Configuration

The basic configuration may import too many issues. For example, maybe you only want to include issues with issue type of “Task” or “Story”. You can do this using GitHub’s query language.

  1. Click on the top-right 3-dot menu and select Project Settings.
  2. Check Use custom GitHub queries checkbox.
  3. Fill in the Query for remaining tasks and Query for past tasks inputs.

After you enter those queries, Monte will validate them using the GitHub API. If the query is invalid, you’ll see an error message with information about what went wrong.

It’s probably a good idea to refine your query in GitHub so you can see exactly what issues are included. You can configure filters in GitHub issues you can see the query language that is used and copy it.

One note: order doesn’t matter for Monte, so there’s no need to include order in the query.

Examples: Query for remaining tasks

repo:org/repo is:open
repo:org/repo is:open is:issue label:task project:website/1

Examples: Query for past tasks

repo:org/repo is:closed closed:>=2024-01-01
repo:org/repo is:closed is:issue closed:>=2024-01-01 label:task project:website/1

For more information on querying GitHub issues, see Filtering and searching issues.

Conclusion

The GitHub connector can save you a lot of time and effort by automatically pulling in the data from your project. Give it a try!

Back to all the posts