Backstage Jenkins Plugin

Build, test, and deploy on Jenkins CI/CD platform.

Getting started is simple

Install the plugin into Backstage.

yarn add @backstage/plugin-jenkins

Add plugin to the list of plugins.

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

Add plugin API to your Backstage instance.

// packages/app/src/components/catalog/EntityPage.tsx
import { 
  Router as JenkinsRouter,
  isPluginApplicableToEntity as isJenkinsAvailable,
  LatestRunCard as JenkinsLatestRunCard,
} from '@backstage/plugin-cloudbuild';

const CICDSwitcher = ({ entity }: { entity: Entity }) => {
  switch (true) {
    ...
    case isJenkinsAvailable(entity):
      return ;
    ...
  }
}

Add proxy configuration

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

Add annotation to your component-info.yaml file.

metadata:
  annotations:
    jenkins.io/github-folder: [folder-name/job-name]

How it looks

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.

We will never sell or share your email address.