Skip to content

Latest commit

 

History

History
125 lines (84 loc) · 5.01 KB

README.md

File metadata and controls

125 lines (84 loc) · 5.01 KB
Raw

Build Monitor plugin for IntelliJ

Version Downloads

Build Monitor

Description

ToolWindow that monitors Workflows/Builds from Github Actions and Buildkite. Setup profiles which automatically refresh the status of your builds alerting you when they complete or fail. Ability to retry failed builds with one click.

Cost

The free to use version of the plugin has 100% of the functionality of the paid version, however it is limited by the number of remote accounts you can configure to one. And you can only setup two "monitor profiles."

Features

Free

  • Connect to Buildkite to monitor Builds.
  • Connect to Github to monitor Workflow actions.
  • Configurable fields to be displayed inline with your monitored builds.
  • Configurable notifications (poups and sounds) based on the status of monitored builds.
  • Configurable filter criteria to limit exactly which builds are monitored.

Paid

  • Unlimited Accounts.
  • Unlimited Monitor Profiles.

Usage

Adding Buildkite Account

Create a new Buildkite API Access Token: https://buildkite.com/user/api-access-tokens.

Using your Buildkite account, create a new API access token with the following permissions:

  • GraphQL API To retrieve users, builds, jobs, and pipelines.
  • Read Pipelines To list and retrieve details of pipeslines.
  • Read Builds To list and retrieve details of builds.
  • Modify Builds To create new, retry failed, and cancel running builds.
  • Read User To retrieve basic details about users.
  • Read Organizations Used to list and retrieve details of builds.
Add account to Project Settings for Plugin.

Settings/Preferences > Tools > Build Monitor Accounts

  1. Click the + icon and give your new account a name.
  2. Select BUILDKITE from the Type field.
  3. Paste your API Access Token into to the Api Access Token field.
  4. Click the Test Connection button to verify everything works.

Skip to instructions below labeled Setup Build Monitor Profile

Adding Github Account

Create a new Personal Access Token: https://github.com/settings/tokens.

Using your Github account, create a new Personal Access Token (classic) with the following permissions:

  • Repository
    • READ Required to read Workflow Actions.
  • Workflow
    • READ To list and retrieve details of workflows and workflow actions.
    • WRITE To Rerun, retry, and cancel workflows.

Settings/Preferences > Tools > Build Monitor Accounts

  1. Click the + icon and give your new account a name.
  2. Select GITHUB from the Type field.
  3. Paste your Personal Access Token into to the Api Access Token field.
  4. Click the Test Connection button to verify everything works.

Skip to instructions below labeled Setup Build Monitor Profile

Setup Build Monitor Profile

Build Monitor Profiles allow you to define which builds/workflows you want to show up in the ToolWindow. You can define multiple profiles, each with varying filter criteria. Additionally, you can alter which pieces of information are displayed inline along side the build.

Settings/Preferences > Tools > Build Monitor Accounts > Monitor Profiles

  1. Click the + icon and give your new profile a name.
  2. Select which Account you want to use.
  3. Define the filter criteria to determine which builds will be displayed.
  4. Display Options allows you to select which pieces of information will be included with the build.
  5. Notification Options allows you select which types of notifications you would like to receive for the builds.

Launch Monitor

From the Tools drop down menu select Build Monitor to open the ToolWindow.

Select a Build Monitor Profile to open the display.

Buildkite Builds
Github Workflows

Bug Reports and Feature Requests

Submit BugReports or Feature Requests: https://github.com/SourceLabOrg/BuildMonitor_IntellijPlugin/issues

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "Build Monitor" > Install Plugin

  • JetBrains Market Place:

    Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...