Backstage - release-2021-07-15
@backstage/plugin-catalog-backend@0.13.0
Minor Changes
-
8bfc0571c: Add a default catalog value for BitBucketDiscoveryProcessor. This allows to have a target like so: https://bitbucket.mycompany.com/projects/backstage/repos/service-*
which will be expanded to https://bitbucket.mycompany.com/projects/backstage/repos/service-a/catalog-info.yaml given that repository 'service-a' exists.Migration
If you are using a custom Bitbucket parser and your
bitbucket-discovery
target (e.g. in your app-config.yaml) omits the catalog path in any of the following ways:- https://bitbucket.mycompany.com/projects/backstage/repos/service-*
- https://bitbucket.mycompany.com/projects/backstage/repos/*
- https://bitbucket.mycompany.com/projects/backstage/repos/*/
then you will be affected by this change.
The 'target' input to your parser before this commit would be '/', and after this commit it will be '/catalog-info.yaml', and as such needs to be handled to maintain the same functionality.
Patch Changes
-
8b048934b: The codeowners processor extracts the username of the primary owner and uses this as the owner field.
Given the kind isn't specified this is assumed to be a group and so the link to the owner in the about card
doesn't work. This change specifies the kind where the entity is a user. e.g:@iain-b
->user:iain-b
-
ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. -
Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/plugin-search-backend-node@0.4.0
## @backstage/plugin-catalog-react@0.3.0
Minor Changes
-
976b61080: Updated the software templates list page (
ScaffolderPage
) to use theuseEntityListProvider
hook from #5643. This reduces the code footprint, making it easier to customize the display of this page, and consolidates duplicate approaches to querying the catalog with filters.- The
useEntityTypeFilter
hook has been updated along with the underlyingEntityTypeFilter
to work with multiple values, to allow more flexibility for different user interfaces. It's unlikely that this change affects you; however, if you're using either of these directly, you'll need to update your usage. SearchToolbar
was renamed toEntitySearchBar
and moved tocatalog-react
to be usable by other entity list pagesUserListPicker
now has anavailableTypes
prop to restrict which user-related options to present
- The
Patch Changes
- d84778c25: Store filter values set in
EntityListProvider
in query parameters. This allows selected filters to be restored when returning to pages that list catalog entities. - e13f0fb9d: Fix
EntityTypeFilter
so it produces unique case-insensitive set of available types
## @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 asrc/plugins/jenkins.ts
file, adding a reference to it tosrc/index.ts
and changing app-config.yamljenkins.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{
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 ofplugin.jenkins.service2
and has entity-based functions to match the endpoints exposed by
the new backend pluginChange 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
## @backstage/plugin-scaffolder-backend@0.14.0
Minor Changes
-
96fc27698: Updated inputs for the
publish:github:pull-request
action.Now requires a
repoUrl
instead of separateowner
andrepo
inputs. This aligns with the output of theRepoUrlPicker
ui field used by the pull-request sample template.
Patch Changes
-
e75506fe7: Unsubscribe from broker after response is flushed
-
ea1d956ef: Updating fs-extra to 10.0.0 to handle broken symbolic links correctly
-
31de5f27f: Add new
fetch:template
action which handles the same responsibilities asfetch:cookiecutter
without the external dependency oncookiecutter
. For information on migrating fromfetch:cookiecutter
tofetch:template
, see the migration guide in the docs. -
84d329e2a: Scaffolder: Added an 'eq' handlebars helper for use in software template YAML files. This can be used to execute a step depending on the value of an input, e.g.:
yaml steps: id: 'conditional-step' action: 'custom-action' if: '{{ eq parameters.myvalue "custom" }}',
-
ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. -
Updated dependencies
- @backstage/backend-common@0.8.6
## @backstage/plugin-search-backend-node@0.4.0
Minor Changes
- 97b2eb37b: Change return value of
SearchEngine.index
toPromise<void>
to support
implementation of external search engines.
## @backstage/plugin-techdocs@0.10.0
Minor Changes
-
94a54dd47: Added a
migrateDocsCase()
method to TechDocs publishers, along with
implementations for AWS, Azure, and GCS.This change is in support of a future update to TechDocs that will allow for
case-insensitive entity triplet URL access to documentation pages which will
require a migration of existing documentation objects in external storage
solutions.See #4367 for details.
Patch Changes
- 537c37b0f: Fix displaying owned documents list by fetching associated entity relations
- 136a91974: Show a "Refresh" button to if the content is stale.
This removes the need to do a full page-reload to display more recent TechDocs content. - f1200f44c: Rewrite the
/sync/:namespace/:kind/:name
endpoint to support an event-stream as response.
This change allows the sync process to take longer than a normal HTTP timeout.
The stream also emits log events, so the caller can follow the build process in the frontend. - 3af126cdd: Provide a Drawer component to follow a running build.
This can be used to debug the rendering and get build logs in case an error occurs. - 2a4a3b32d: Techdocs: fix sidebars not adjusting position automatically
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-user-settings@0.3.0
Minor Changes
- 71afed7f3: Exported and renamed components from the
@backstage/plugin-user-settings
plugin , to be able to use it in the consumer side and customize theSettingPage
## @backstage/backend-common@0.8.6
Patch Changes
-
5f6f2fd96: Support a
ensureExists
config option to skip ensuring a configured database exists. This allows deployment scenarios where
limited permissions are given for provisioned databases without privileges to create new databases. If set tofalse
, the
database connection will not be validated prior to use which means the backend will not attempt to create the database if it
doesn't exist. You can configure this in your app-config.yaml:yaml backend: database: ensureExists: false
This defaults to
true
if unspecified. You can also configure this per plugin connection and will override the base option. -
ad93bb035: Document the default behavior of
statusCheck
option increateStatusCheckRouter
. -
ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. -
Updated dependencies
- @backstage/config-loader@0.6.5
## @backstage/cli@0.7.4
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/config-loader@0.6.5
## @backstage/config-loader@0.6.5
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably.
## @backstage/create-app@0.3.31
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably.
## @backstage/dev-utils@0.2.2
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/techdocs-common@0.6.8
Patch Changes
-
d5eaab91d: Adds custom docker image support to the techdocs generator. This change adds a new
techdocs.generator
configuration key and deprecates the existingtechdocs.generators.techdocs
key.yaml techdocs: # recommended, going forward: generator: runIn: 'docker' # or 'local' # New optional settings dockerImage: my-org/techdocs # use a custom docker image pullImage: false # disable automatic pulling of image (e.g. if custom docker login is required) # legacy (deprecated): generators: techdocs: 'docker' # or 'local'
-
c18e8eb91: Provide optional
logger: Logger
andlogStream: Writable
arguments to theGeneratorBase#run(...)
command.
They receive all log messages that are emitted during the generator run. -
ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. -
Updated dependencies
- @backstage/backend-common@0.8.6
## @backstage/plugin-api-docs@0.6.2
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog@0.6.7
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-app-backend@0.3.15
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/config-loader@0.6.5
## @backstage/plugin-auth-backend@0.3.17
Patch Changes
- 40b3c60e2: Configuration updates for the
OpenID Connect
auth provider to allowprompt
configuration and some sensible defaults. - f55f9df10: Add Sign In and Handler resolver for Microsoft provider
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/backend-common@0.8.6
## @backstage/plugin-badges@0.2.5
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-bitrise@0.1.7
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-catalog@0.6.7
Patch Changes
- 75a532fbe: Add unstable prop for disabling unregister entity menu
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-catalog-backend-module-ldap@0.2.1
Patch Changes
- afe3e4b54: Expose missing types used by the custom transformers
- Updated dependencies
- @backstage/plugin-catalog-backend@0.13.0
## @backstage/plugin-catalog-backend-module-msgraph@0.2.2
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-backend@0.13.0
## @backstage/plugin-catalog-import@0.5.13
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-circleci@0.2.19
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-cloudbuild@0.2.19
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-code-coverage@0.1.7
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-explore@0.3.10
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-fossa@0.2.11
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-github-actions@0.4.13
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-github-deployments@0.1.11
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-ilert@0.1.6
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-kafka@0.2.11
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-kubernetes@0.4.8
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-kubernetes-backend@0.3.10
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/backend-common@0.8.6
## @backstage/plugin-lighthouse@0.2.20
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-org@0.3.17
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-pagerduty@0.3.8
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-register-component@0.2.20
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-rollbar@0.3.9
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-rollbar-backend@0.1.13
Patch Changes
- ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/backend-common@0.8.6
## @backstage/plugin-scaffolder@0.10.1
Patch Changes
-
73951fc44: Add options to mask or hide values on review state
-
976b61080: Updated the software templates list page (
ScaffolderPage
) to use theuseEntityListProvider
hook from #5643. This reduces the code footprint, making it easier to customize the display of this page, and consolidates duplicate approaches to querying the catalog with filters.- The
useEntityTypeFilter
hook has been updated along with the underlyingEntityTypeFilter
to work with multiple values, to allow more flexibility for different user interfaces. It's unlikely that this change affects you; however, if you're using either of these directly, you'll need to update your usage. SearchToolbar
was renamed toEntitySearchBar
and moved tocatalog-react
to be usable by other entity list pagesUserListPicker
now has anavailableTypes
prop to restrict which user-related options to present
- The
-
Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-scaffolder-backend-module-rails@0.1.3
Patch Changes
- e114cc7e0: updated paths to consider differences between platform (windows corrected)
- Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/plugin-scaffolder-backend@0.14.0
## @backstage/plugin-search@0.4.3
Patch Changes
- 078d4973e: Handle request errors properly and display them in the results list.
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-search-backend@0.2.3
Patch Changes
- Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/plugin-search-backend-node@0.4.0
## @backstage/plugin-sentry@0.3.15
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-sonarqube@0.1.22
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-splunk-on-call@0.3.5
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## @backstage/plugin-techdocs-backend@0.8.7
Patch Changes
- f1200f44c: Rewrite the
/sync/:namespace/:kind/:name
endpoint to support an event-stream as response.
This change allows the sync process to take longer than a normal HTTP timeout.
The stream also emits log events, so the caller can follow the build process in the frontend. - 35a67722b: It is no longer required to provide a generator and a preparer to the TechDocs
router factory when running TechDocs in the "recommended" (e.g. externally
prepared and generated docs) configuration. - ae84b20cf: Revert the upgrade to
fs-extra@10.0.0
as that seemed to have broken all installs inexplicably. - Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/techdocs-common@0.6.8
## @backstage/plugin-todo@0.1.5
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog-react@0.3.0
## example-app@0.2.37
Patch Changes
- Updated dependencies
- @backstage/plugin-catalog@0.6.7
- @backstage/plugin-catalog-react@0.3.0
- @backstage/plugin-scaffolder@0.10.1
- @backstage/plugin-techdocs@0.10.0
- @backstage/plugin-jenkins@0.5.0
- @backstage/plugin-user-settings@0.3.0
- @backstage/plugin-search@0.4.3
- @backstage/cli@0.7.4
- @backstage/plugin-api-docs@0.6.2
- @backstage/plugin-badges@0.2.5
- @backstage/plugin-catalog-import@0.5.13
- @backstage/plugin-circleci@0.2.19
- @backstage/plugin-cloudbuild@0.2.19
- @backstage/plugin-code-coverage@0.1.7
- @backstage/plugin-explore@0.3.10
- @backstage/plugin-github-actions@0.4.13
- @backstage/plugin-kafka@0.2.11
- @backstage/plugin-kubernetes@0.4.8
- @backstage/plugin-lighthouse@0.2.20
- @backstage/plugin-org@0.3.17
- @backstage/plugin-pagerduty@0.3.8
- @backstage/plugin-rollbar@0.3.9
- @backstage/plugin-sentry@0.3.15
- @backstage/plugin-todo@0.1.5
## example-backend@0.2.37
Patch Changes
- Updated dependencies
- @backstage/backend-common@0.8.6
- @backstage/plugin-scaffolder-backend@0.14.0
- @backstage/plugin-catalog-backend@0.13.0
- @backstage/plugin-auth-backend@0.3.17
- @backstage/plugin-scaffolder-backend-module-rails@0.1.3
- @backstage/plugin-search-backend-node@0.4.0
- @backstage/plugin-techdocs-backend@0.8.7
- @backstage/plugin-app-backend@0.3.15
- @backstage/plugin-kubernetes-backend@0.3.10
- @backstage/plugin-rollbar-backend@0.1.13
- example-app@0.2.37
- @backstage/plugin-search-backend@0.2.3
Details
- 🔍View and search all Backstage releases.
- 🛠️Create and share lists to track your tools.
- 🚨Setup notifications for major, security, feature or patch updates.
- 🚀Much more coming soon!