search

plouc / mozaik-ext-jenkins

Mozaïk jenkins widgets
MIT License
10 stars 26 forks source link

readme

Mozaïk jenkins widgets

License Travis CI NPM version Dependencies Coverage Status widget count

Jenkins Client Configuration

In order to use the Mozaïk jenkins widgets, you must configure its client.

parameters

key env key required description notes
baseUrl JENKINS_API_BASE_URL yes jenkins base url
basicAuthUser JENKINS_API_BASIC_AUTH_USER yes jenkins auth user
basicAuthPassword JENKINS_API_BASIC_AUTH_PASSWORD yes jenkins auth password
customCa JENKINS_API_CUSTOM_CA no jenkins certificate require mozaik-ext-jenkins >= 1.1.0

usage

{
  //…
  api: {
    jenkins: {
      baseUrl: 'https://my-jenkins.ci',
        basicAuthUser:     'user',
        basicAuthPassword: 'password'
    }
  }
}

Jenkins Job Builds

jenkins job builds

Show jenkins job builds.

parameters

key required description
job yes jenkins job identifier
title no Widget title (Jenkins job builds if none provided)

usage

{
  type: 'jenkins.job_builds', job: 'my-job',
  columns: 1, rows: 1, x: 0, y: 0
}

Jenkins Job Builds Histogram

jenkins job builds histogram

Show jenkins job builds histogram.

parameters

key required description
job yes jenkins job identifier

usage

{
  type: 'jenkins.job_builds_histogram', job: 'my-job',
  columns: 1, rows: 1, x: 0, y: 0
}

Jenkins Job Status

jenkins job status

jenkins job status bold

Display job current build status.

parameters

key required description notes
job yes jenkins job identifier
layout no widget layout (none for default or 'bold') require mozaik-ext-jenkins >= 1.1.0

usage

{
  type: 'jenkins.job_status', job: 'my-job',
  columns: 1, rows: 1, x: 0, y: 0
}

Jenkins Job Status With Progress

jenkins job status

Display job current build status with progress % - based on Job Status - bold.

parameters

key required description notes
job yes jenkins job identifier

usage

{
  type: 'jenkins.job_status_progress', job: 'my-job',
  columns: 1, rows: 1, x: 0, y: 0
}

Jenkins View

jenkins view

List view jobs

parameters

key required description
view yes jenkins view identifier
title no widget title (view name used if none provided)

usage

{
    type: 'jenkins.view', view: 'dev-env',
    columns: 2, rows: 1, x: 0, y: 0
}