Skip to content

Visualize build status of a Jenkins job on a Razer Chroma compatible keyboard

License

Notifications You must be signed in to change notification settings

thowimmer/JenkinsToRazer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JenkinsToRazer

GitHubActionsCIBuild

Visualize build status of Jenkins jobs on a Razer Chroma compatible keyboard.

Currently supported platforms

  • Windows

Downloads

Latest stable release

Download the executable binary from the latest release section

Configuration

The sample jenkins2razer.json shows how to configure the job visualization on your keyboard with the following properties:

Option: url

The URL of the Jenkins instance.

Option: auth.username

The Jenkins user used retrieve the build job information.

Option: auth.password

The Jenkins API token or password.

Option: razer.backgroundEffect

The id of the background effect. Currently only effects of type STATIC are allowed.

Option: buildJobs

Array of build jobs to display on the keyboard.

Option: buildJobs[i].id

Unique numerical identifier of the job.

Option: buildJobs[i].job

Identifier of the Jenkins job.

Option: buildJobs[i].branch

Optional branch name. Only required if the job is a Multibranch Pipeline job.

Option: buildJobs[i].keyColumn

The column index of the keyboard key used to visualize the build status.

Option: buildJobs[i].keyRow

The row index of the keyboard key used to visualize the build status.

Option: buildJobs[i].buildInProgressEffect

Identifier of the effect which is visualized if the build is in progess.

Option: buildJobs[i].buildSuccessfulEffect

Identifier of the effect which is visualized if the build finished successfully.

Option: buildJobs[i].buildFailedEffect

Identifier of the effect which is visualized if the build failed.

Option: effects

Array of effects which are referenced in the razer and buildJob configuration.

Option: effects[i].id

Unique alphanumeric identifier of the effect.

Option: effects[i].type

Discriminator for the effect type. One of STATIC or BLINK.


Options for STATIC effect types

Option: effects[i].rgbHex

RGB hex string of the static color.


Options for BLINK effect types

Option: effects[i].rgbOnHex

RGB hex string if blink toggle is on.

Option: effects[i].rgbOffHex

RGB hex string if blink toggle is off.

How to use

Windows

1) Install Razer Synapse 3

Download and install Razer Synapse 3

2) Copy configuration to user home

Copy your jenkins2razer.json configuration file to your users home directory (C:\Users<username>).

3) Execute JenkinsToRazer.exe

Execute JenkinsToRazer.exe in the Windows command line.

References