Version Packages

plugins/jenkins/CHANGELOG.md

@@ -1,5 +1,85 @@
 # @backstage/plugin-jenkins
 
+## 0.5.0
+
+### Minor Changes
+
+- 6c7f00eb0: ## Extract an entity-oriented Jenkins Backend
+
+  Change the Jenkins plugin from talking directly with a single Jenkins instance (via the proxy) to having a specific
+  backend plugin which talks to the Jenkins instances.
+
+  Existing users of the Jenkins plugin will need to configure a Jenkins backend instead of a proxy.
+  Typically, this means creating a `src/plugins/jenkins.ts` file, adding a reference to it to `src/index.ts` and changing app-config.yaml
+
+  ### jenkins.ts
+
+  ```typescript
+  import {
+    createRouter,
+    DefaultJenkinsInfoProvider,
+  } from '@backstage/plugin-jenkins-backend';
+  import { CatalogClient } from '@backstage/catalog-client';
+  import { Router } from 'express';
+  import { PluginEnvironment } from '../types';
+
+  export default async function createPlugin({
+    logger,
+    config,
+    discovery,
+  }: PluginEnvironment): Promise<Router> {
+    const catalogClient = new CatalogClient({ discoveryApi: discovery });
+
+    return await createRouter({
+      logger,
+      jenkinsInfoProvider: new DefaultJenkinsInfoProvider(
+        catalogClient,
+        config,
+      ),
+    });
+  }
+  ```
+
+  ### app-config.yaml
+
+  For example
+
+  ```yaml
+  proxy:
+    '/jenkins/api':
+      target: 'https://jenkins.example.com:8080' # your Jenkins URL
+      changeOrigin: true
+      headers:
+        Authorization: Basic ${JENKINS_BASIC_AUTH_HEADER}
+  ```
+
+  Would become:
+
+  ```yaml
+  jenkins:
+    baseUrl: https://jenkins.example.com:8080
+    username: backstage-bot
+    apiKey: ${JENKINS_PASSWORD}
+  ```
+
+  ## Change JavaScript API
+
+  As part of the above change, the JavaScript API exposed by the plugin as a possible place for customisation has changed.
+  The ApiRef now has an id of `plugin.jenkins.service2` and has entity-based functions to match the endpoints exposed by
+  the new backend plugin
+
+  ## Change BuildWithStepsPage route
+
+  The plugin originally provided a route to view a particular build of a particular branch so that if you wanted to view
+  the master branch of an entity annotated with `'jenkins.io/github-folder': teamA/artistLookup-build` you could typically
+  access `/catalog/default/component/artist-lookup/ci-cd/run/master/7` but would now have to access
+  `/catalog/default/component/artist-lookup/ci-cd/build/teamA%2FartistLookup-build%2Fmaster/7`
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-react@0.3.0
+
 ## 0.4.7
 
 ### Patch Changes

plugins/jenkins/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-jenkins",
-  "version": "0.4.7",
+  "version": "0.5.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
@@ -34,7 +34,7 @@
     "@backstage/catalog-model": "^0.9.0",
     "@backstage/core-components": "^0.1.5",
     "@backstage/core-plugin-api": "^0.1.3",
-    "@backstage/plugin-catalog-react": "^0.2.6",
+    "@backstage/plugin-catalog-react": "^0.3.0",
     "@backstage/theme": "^0.2.8",
     "@material-ui/core": "^4.11.0",
     "@material-ui/icons": "^4.9.1",
@@ -47,9 +47,9 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.7.3",
+    "@backstage/cli": "^0.7.4",
     "@backstage/core-app-api": "^0.1.4",
-    "@backstage/dev-utils": "^0.2.1",
+    "@backstage/dev-utils": "^0.2.2",
     "@backstage/test-utils": "^0.1.14",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^11.2.5",