Jenkins Plugin (Alpha)

Website: https://jenkins.io/

Setup

If you have a standalone app (you didn't clone this repo), then do

yarn add @backstage/plugin-jenkins

Add plugin:

// packages/app/src/plugins.ts
export { plugin as Jenkins } from '@backstage/plugin-jenkins';

Add proxy configuration to app-config.yaml

proxy:
  '/jenkins/api':
    target: 'http://localhost:8080' # your Jenkins URL
    changeOrigin: true
    headers:
      Authorization:
        $env: JENKINS_BASIC_AUTH_HEADER

Add an environment variable which contains the Jenkins credentials, (note: use an API token not your password). Here user is the name of the user created in Jenkins.

HEADER=$(echo -n user:api-token | base64)
export JENKINS_BASIC_AUTH_HEADER="Basic $HEADER"

Run app with yarn start
Add the Jenkins folder annotation to your catalog-info.yaml, (note: currently this plugin only supports folders and Git SCM)

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: 'your-component'
  description: 'a description'
  annotations:
    jenkins.io/github-folder: 'folder-name/job-name'
spec:
  type: service
  lifecycle: experimental
  owner: your-name

Register your component
Click the component in the catalog you should now see Jenkins builds, and a last build result for your master build.

Note:

If you are not using environment variable then you can directly type API token in app-config.yaml

proxy:
  '/jenkins/api':
    target: 'http://localhost:8080' # your Jenkins URL
    changeOrigin: true
    headers:
      Authorization: Basic YWRtaW46MTFlYzI1NmU0Mzg1MDFjM2Y1Yzc2Yjc1MWE3ZTQ3YWY4Mw==

YWRtaW46MTFlYzI1NmU0Mzg1MDFjM2Y1Yzc2Yjc1MWE3ZTQ3YWY4Mw== is the base64 of user and it's API token e.g. admin:11ec256e438501c3f5c76b751a7e47af83

Features

View all runs inside a folder
Last build status for specified branch
View summary of a build

Limitations

Only works with organization folder jobs backed by GitHub
No pagination support currently, limited to 50 jobs - don't run this on a Jenkins with lots of builds