Introduction

Note

This guide is for Github projects (V2).
If you want to create a Jira software project monitor, follow this guide .

Creating a monitor is easy.

OpenSource

Creating a monitor is easy!

1. Copy your project url.
2. Visit create-monitor.

1. Copy the project url

Go to the project dashboard, you want to display, and copy it’s url. The url has the following format: https://-your-organization-name-.atlassian.net/jira/software/projects/-your-project-name-/boards/1

The board number doesn’t matter, propromo does only fetch the basic data, not the board information.

2. Visit create-monitor

Visit create-monitor and paste the url in the input field.

PrivateDomain

Creating a monitor is easy!

1. Create a new github pat token.
2. Copy your project url.
3. Visit create-monitor.

1. Create a new github pat token

If you want to create a monitor and the project you want to display is private, you need a Github pat token with read scopes first.

You can create such token at github.com/settings/tokens. These are the needed scopes you need to select (read-only needed, no write access):

Note: If the project is public, you just need the url of the project.

2. Copy the project url

Go to the project dashboard, you want to display, and copy it’s url. The url has the following format: https://github.com/-users or orgs-/-login-name-/projects/-id-/views/-id-

The view part does not matter, propromo can only fetch the milestones and issues, not the views. (version 2022-11-28 (latest) of the github-rest-api does not support that).

3. Visit create-monitor

Visit create-monitor and paste the url and the token in the input fields.