Update all dependencies #5
Reference in New Issue
Block a user
No description provided.
Delete Branch "renovate/all"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
^0.14.0->^0.21.0^0.3.2->^0.5.0^0.17.2->^0.26.0^0.17.2->^0.26.0^0.9.5->^0.14.0^0.8.6->^0.11.0^0.14.1->^0.22.0^0.2.2->^0.5.0^0.2.18->^0.4.0^0.8.9->^0.10.0^0.5.6->^0.6.0^0.5.6->^0.6.0^0.6.2->^0.7.0^0.6.2->^0.7.0^0.2.27->^0.4.0^0.9.0->^1.0.0^0.5.3->^1.0.0^0.3.4->^0.5.0^0.6.2->^1.0.0^0.2.1->^1.0.0^0.5.13->^0.7.0^0.4.5->^0.8.0^0.2.15->^0.5.0^12.0.0->^15.0.0^5.10.1->^6.0.0^12.1.3->^14.0.0^12.0.7->^14.0.0^2.0.4->^3.0.0^14.14.32->^20.0.0^7.5.0->^9.0.0^6.0.0->^8.0.0^3.1.5->^4.0.0^9.7.0->^13.0.0^3.3.1->^4.0.0^0.42.0->^2.0.014 || 16->14 || 16 || 2016-bullseye-slim->21-bullseye-slim^2.3.2->^3.0.0^15.3.3->^17.0.0^1.10.11->^2.0.0~4.6.4->~5.4.0Release Notes
backstage/backstage (@backstage/backend-common)
v0.21.6Compare Source
Patch Changes
81a995f: Updated dependencyaws-sdk-client-mockto^4.0.0.v0.21.5Compare Source
Patch Changes
81a995f: Updated dependencyaws-sdk-client-mockto^4.0.0.v0.21.4Compare Source
Patch Changes
7422430: Resolve thebasePathbefore constructing the target path999224f: Bump dependencyminimatchto v9e0b997c: Fix issue whereresolveSafeChildPathpath would incorrectly resolve when operating on a symlink9802004: Added theUserInfoApias both an optional input and as an output forcreateLegacyAuthAdapters2af5354: Bump dependencyjoseto v5ff40ada: Updated dependencymysql2to^3.0.0.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.568881f: Updated dependencyyauzlto^3.0.0.4a3d434: Added acreateLegacyAuthAdaptersfunction that can be used as a compatibility adapter for backend plugins who want to start using the newauthandhttpAuthservices that were created as part of BEP-0003.See the Auth Service Migration tutorial for more information on the usage of this adapter.
Updated dependencies
v0.21.3Compare Source
Patch Changes
7422430: Resolve thebasePathbefore constructing the target path999224f: Bump dependencyminimatchto v9e0b997c: Fix issue whereresolveSafeChildPathpath would incorrectly resolve when operating on a symlink9802004: Added theUserInfoApias both an optional input and as an output forcreateLegacyAuthAdapters2af5354: Bump dependencyjoseto v5ff40ada: Updated dependencymysql2to^3.0.0.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.568881f: Updated dependencyyauzlto^3.0.0.4a3d434: Added acreateLegacyAuthAdaptersfunction that can be used as a compatibility adapter for backend plugins who want to start using the newauthandhttpAuthservices that were created as part of BEP-0003.See the Auth Service Migration tutorial for more information on the usage of this adapter.
Updated dependencies
v0.21.2Compare Source
v0.21.1Compare Source
Released a new
@backstage/plugin-config-schemaplugin that is used to show the config schema in a reference documentation format. It's intended for integrators rather than end users, and the idea is to also hook this up to a CLI command that allows browsing of the local schema.v0.21.0Compare Source
Minor Changes
bbe374e: BREAKING:A gitilesBaseUrlmust be provided for the Gerrit integration to work.You can disable this check by setting
DISABLE_GERRIT_GITILES_REQUIREMENT=1butthis will be removed in a future release. If you are not able to use the Gitiles
Gerrit plugin, please open an issue towards
https://github.com/backstage/backstagee85aa98: drop databases after unit tests if the database instance is not running in dockerPatch Changes
6707216: Added a newLegacyRootDatabaseServiceinterface that can be used to avoid direct dependencies on theDatabaseManager.842171a: Fix a bug with S3 Fetch that caused all objects to be flattened within a single folder on the local file system.3489d05:FetchUrlReader#readUrl()now supports passing an optionaltokento authenticate requests.9aac2b0: Use--cwdas the firstyarnargumentece5a8f: Add a User-Agent header for calls towards Google Cloud Storage.1f020fe: SupporttokeninreadTree,readUrlandsearch6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.d2e3ab9: Updated dependencydockerodeto^4.0.0.1cae748: Updated dependencygit-url-parseto^14.0.0.e27b7f3: Fix rate limit detection by looking for HTTP status code 429 and updating the headerx-ratelimit-remainingto look for in case of a 403 code is returned7fb7a79: Add a config declaration forworkingDirectoryv0.20.2Compare Source
v0.20.1Compare Source
Patch Changes
3b24eae: Adding support for removing file from git index454d17c: Do not call fetch directly but rather usefetchResponsefacilityb6b15b2: Use sha256 instead of md5 for hash key calculation in cachesThis can have a side effect of invalidating caches (when cache key was >250 characters)
This improves compliance with FIPS nodejs
Updated dependencies
v0.20.0Compare Source
Minor Changes
870db76: ImplementedreadTreefor Gitea provider to support TechDocs functionalityPatch Changes
7f04128: Allow a default cache TTL to be set through the app config1ad8906: UseReadable.fromto fix some of the stream issuesd86a007: Fixed the AwsS3UrlReader host regex and host to allow the S3 reading for CN AWS domainbc67498: Updated dependencyarchiverto^6.0.0.Updated dependency
@types/archiverto^6.0.0.706fc3a: Updated dependency@kubernetes/client-nodeto0.20.0.2666675: Updated dependency@google-cloud/storageto^7.0.0.d15d483: Add command--runAsDefaultUserfor@techdocs/cli generateto bypass running the docker builds as host user for macOS and Linux.d1e00aa: Expose anonAuthhandler forgitactions to provide custom credentialsv0.19.10Compare Source
v0.19.9Compare Source
Patch Changes
aa13482: Limit the database creation concurrency to one, defensively013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.3d04352: Updated dependencyaws-sdk-client-mockto^3.0.0.v0.19.8Compare Source
Patch Changes
74491c9: TheHostDiscoveryexport has been deprecated, import it from@backstage/backend-app-apiinstead.b95d66d: Properly close write stream when writing temporary archive for processing zip-based.readTree()responses.b94f322: Added the ability to fetch git tags through theGitclass. This is useful for scaffolder actions that want to take action based on tag versions in a cloned repository0b55f77: Removed some unused dependencies4c39e38: Added/testUtilsentry point, with a utility for mocking resolve package paths as returned byresolvePackagePath.9101c0d: Updated dependency@kubernetes/client-nodeto0.19.0.a250ad7: Removedmock-fsdev dependency.2a40cd4: Adds the optional flag for useRedisSets for the Redis cache to the config.1c3d6fa: TheuseHotCleanupanduseHotMemoizehelpers are now deprecated, since hot module reloads for backend are being phased out.v0.19.7Compare Source
Patch Changes
b94f322: Added the ability to fetch git tags through theGitclass. This is useful for scaffolder actions that want to take action based on tag versions in a cloned repositoryv0.19.6Compare Source
v0.19.5Compare Source
Patch Changes
6847cd6: Avoid starting database keepalive loop in tests.fd3fdd0: The root logger is now initialized lazily, fixing a circular dependency issue with@backstage/backend-app-apithat would result inCannot read properties of undefined (reading 'redacter').5f1a92b: UseDefaultAzureDevOpsCredentialsProviderto retrieve credentials for Azure DevOps.19a1404: Added retries for initial database creation, as well as set minimum connection pool size for the database creation client to 0 and lowered the connection acquisition timeout.05508a9: Minor internal refactorcfc3ca6: Changes needed to support MySQLv0.19.4Compare Source
Patch Changes
5f1a92b: UseDefaultAzureDevOpsCredentialsProviderto retrieve credentials for Azure DevOps.cfc3ca6: Changes needed to support MySQLv0.19.3Compare Source
v0.19.2Compare Source
Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config443afcf: To improve performance,GerritUrlReader.readTree()now uses Gitiles to fetch an archive instead of cloning the repository.If
gitilesBaseUrlis not configured,readTreestill uses Git to clone the repository.Added
stripFirstDirectoryoption toReadTreeResponseFactory.fromTarArchive(), allowing to disable stripping first directoryfor
tararchives.4b82382: Fixed invalid configuration schema. The configuration schema may be more strict as a result.Updated dependencies
v0.19.1Compare Source
Patch Changes
787ddcc: useReadable.fromto explicitly convert thebufferfromnode-fetchto aReadablestreamv0.19.0Compare Source
Minor Changes
c7f848b: Support authentication with a service principal or managed identity for Azure DevOpsAzure DevOps recently released support, in public preview, for authenticating with a service principal or managed identity instead of a personal access token (PAT): https://devblogs.microsoft.com/devops/introducing-service-principal-and-managed-identity-support-on-azure-devops/. With this change the Azure integration now supports service principals and managed identities for Azure AD backed Azure DevOps organizations. Service principal and managed identity authentication is not supported on Azure DevOps Server (on-premises) organizations.
Patch Changes
4ef91ab: Updated the backend database connection configuration schema to set the password visibility to secret52d5998: Changed the default backend CacheClient to an in-memory cache when not explicitly configured.Explicit configuration of an in-memory cache can be removed from
app-config.yaml, as this is now the default:5f2c38c: Fix SNYK-JS-FASTXMLPARSER-5668858 (fast-xml-parser) by upgrading aws-sdk to at least the current latest version.eeb3f80:HostDiscoverynow strips trailing slashes in thebackend.baseUrlconfig.9f47a74: Fixed typo in HostDiscovery's JSDoc810c6de: Remove unused dev dependencyaws-sdk-mock.Updated dependencies
v0.18.5Compare Source
Patch Changes
0297f7a: Remove the direct dependency on deprecated "request" library284db22: Updated theDatabaseManagerto include the plugin id in the Postgres application name of the database connections created for each plugin.3659c71: Standardize@aws-sdkv3 versions42d817e: AddedHostDiscoveryto supersede deprecatedSingleHostDiscovery(deprecated due to name)v0.18.4Compare Source
Patch Changes
a1002df: Support commit hashes atGithubUrlReader.readTree/searchadditionally to branch names.Additionally, this will reduce the number of API calls from 2 to 1 for retrieving the "repo details"
for all cases besides when the default branch has to be resolved and used
(e.g., repo URL without any branch or commit hash).
5c7ce58: Allow an additionalConfig to be provided to loadBackendConfig that fetches config values during runtime.2b15cb4: The dependency isomorphic-git is now on version 1.23.03416727: Renamed theloadBackendConfigoptionadditionalConfigtoadditionalConfigsas an array, and ensured that they get passed on properly.This is technically breaking, but the original addition hasn't been released in mainline yet so we are taking this step now as a
patchchange.4201645: Improve GitlabUrlReader to only load requested sub-pathUpdated dependencies
v0.18.3Compare Source
Patch Changes
f750978: Adds config optionbackend.database.roleto set ownership for newly created schemas and tables in PostgresThe example config below connects to the database as user
v-backstage-123but sets the ownership ofthe create schemas and tables to
backstage928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.87f0bbe: AwsS3UrlReader upgraded to use aws-sdk v3c1ee073: AddedlastModifiedAtfield onUrlReaderServiceresponses and alastModifiedAfteroption toUrlReaderService.readUrl.482dae5: Updated link to docs.Updated dependencies
v0.18.2Compare Source
Patch Changes
5febb21: BREAKING: TheCacheClientinterface must now also implement thewithOptionsmethod. The.get()method has also received a type parameter that helps ensure thatundefinedin the event of a cache miss is handled.Added a
cacheToPluginCacheManagerhelper that converts aCacheServiceinto a legacyPluginCacheManagerinstance.5febb21: Updated to match the newCacheServiceinterface.e716946: Updated usage of the lifecycle service.d31d8e0: Updated to work with the newtype: 'pem'withcreateHttpServerfrom@backstage/backend-app-api0ff0331: Updated usage ofcreateBackendPlugin.f60cca9: TheDatabaseManager.forPluginmethod now accepts additional service dependencies. There is no need to update existing code to pass these dependencies.628e2bd: Updated dependency@kubernetes/client-nodeto0.18.1.Updated dependencies
v0.18.1Compare Source
Added a new badges plugin, split into
@backstage/plugin-badgesand@backstage/plugin-badges-backend.The badges plugin offers a set of badges that can be used outside of your backstage deployment, showing information related to data in the catalog, such as entity owner and lifecycle data.
v0.18.0Compare Source
Minor Changes
5e2cebe: BREAKING: Removed deprecatedreadmethod from theUrlReaderinterface. All implementations should use thereadUrlmethod instead.Migrated
UrlReaderand related types tobackend/backend-plugin-api, types remain re-exported frombackend-commonfor now.Patch Changes
0e63aab: Internal refactor of the logger and configuration loading implementations.31e2309: AddedlegacyPluginand the lower levelmakeLegacyPluginwrappers that convert legacy plugins to the new backend system. This will be used to ease the future migration to the new backend system, but we discourage use of it for now.8e06f3c: AddedloggerToWinstonLogger, which was moved from@backstage/backend-plugin-api.2b1554c: Replaced dependencies on theLoggertype fromwinstonwithLoggerServicefrom@backstage/backend-plugin-api. This is not a breaking change as theLoggerServiceis a subset of theLoggerinterface.5437fe4: Migrated types related toTokenManagerService,CacheServiceandDatabaseServiceinto backend-plugin-api.6f02d23: MovedPluginEndpointDiscoverytype from backend-common to backend-plugin-api.d592ec4: Updated the logger created bycreateRootLoggerto make it possible to override the defaultservicelog label.b99c030: Refactor to rely on@backstage/backend-app-apifor the implementation ofcreateServiceBuilder.f23eef3: Updated dependencybetter-sqlite3to^8.0.0.v0.17.0Compare Source
Minor Changes
de8a975: Changed to use nativeAbortControllerandAbortSignalfrom Node.js, insteadof the one from
node-abort-controller. This is possible now that the minimumsupported Node.js version of the project is 16.
Note that their interfaces are very slightly different, but typically not in a
way that matters to consumers. If you see any typescript errors as a direct
result from this, they are compatible with each other in the ways that we
interact with them, and should be possible to type-cast across without ill
effects.
Patch Changes
d3fea4a: Internal fixes to avoid implicit usage of globals98776e6: Fixed GitlabUrlReader to include api tokens in API calls1f2b2de: exported KubernetesContainerRunner, KubernetesContainerRunnerOptions, KubernetesContainerRunnerMountBase840f211: FixGitlabUrlReader.readTreebug when there were no matching commits20a5161: Adds MySQL support for the catalog-backend3280711: Updated dependencymswto^0.49.0.9ce7866: Updated dependency@kubernetes/client-nodeto0.18.0.3c1302c: Updated dependency@types/http-errorsto^2.0.0.6b82598: Added the ability to understand Job Artifact URLs to the GitLab integrationdfc8edf: Internal refactor to avoid usage of deprecated symbols.8015ff1: Tweaked wording to use inclusive terminology8646067: FixedSingleHostDiscoveryso that it properly handles single-stringbackend.listenconfigurations such as:80.v0.16.0Compare Source
Minor Changes
a7607b5: BREAKING CHANGE: TheUrlReaderinterface has been updated to require thatreadUrlis implemented.readUrlhas previously been optional to implement but a warning has been logged when calling its predecessorread.The
readmethod is now deprecated and will be removed in a future release.Patch Changes
88f99b8: Bumpedtardependency to^6.1.12in order to ensure Node.js v18 compatibility.5522771: Generated development HTTPS backend certificate is now checked for expiration date instead of file age.d05e184: This patch adds GiteaURLReader to the available classes. It currently only reads single files via gitea's public repos apie6ced24: Change to using@keyv/memcachenow thatkeyv-memcacheis deprecated210a3b5: Small update to fix compatibility with newer versions of thekeyvlibrarycfb30b7: Pin@kubernetes/client-nodeversion to0.17.0.c1784a4: Replaces in-code uses ofGitHubwithGithuband deprecates old versions.v0.15.2Compare Source
Patch Changes
e8d7976: Added back support for when no branch is provided for the Bitbucket ServerUrlReaderc44cf41: Fix BitBucket server integrationc31f7cd: Fixed an issue wheregetClient()for apluginIdwould return different clients and not share them2d3a5f0: Useresponse.jsonrather thanresponse.sendwhere appropriate, as outlined inSECURITY.mdv0.15.1Compare Source
Patch Changes
399286d: Workaround support forswcinstead ofsucraseeadf56b: Bumpgit-url-parseversion to^13.0.0c3c9028: Added a keep-alive refresh loop to theDatabaseManager, keeping the connectionpool up.
c3c9028: The options part ofDatabaseManager.fromConfignow accepts an optional loggerfield.
3d4f5da: Remove use of deprecated trimLeft/trimRightbf3cc13: Implemented KubernetesContainerRunner: a ContainerRunner implementation that leverages Jobs on a kubernetes clustere3b1993: Added port ranges in allowed hosts:2f52e74: Got rid of usages of the uppercase String type60b85d8: Updated dependencyhelmetto^6.0.0.Please note that these policies are no longer applied by default:
helmet.contentSecurityPolicy no longer sets block-all-mixed-content directive by default
helmet.expectCt is no longer set by default. It can, however, be explicitly enabled. It will be removed in Helmet 7.
667d917: Updated dependencymswto^0.47.0.87ec2ba: Updated dependencymswto^0.46.0.bf5e903: Updated dependencymswto^0.45.0.709f468: Thebranchcommand has been added to theisomorphic-gitwrapper.0c78027: Fix for entries being skipped or incomplete when reading large zip archives.96689fb: Workaround for a rare race condition in tests.Updated dependencies
v0.15.0Compare Source
Minor Changes
12e9b54: Added back support for when no branch is provided to theUrlReaderfor Bitbucket Server30012e7: - AddedforceandremoteRefoption topushmethod ingitactionsaddRemoteanddeleteRemotemethods togitactionsPatch Changes
fc8a5f7: Improvescm/gitwrapper aroundisomorphic-gitlibrary :checkoutfunction,remoteRefparameter in thepushfunction.5e4dc17: Added a second validation to thedir()method of ZIP archive responses returned fromreadTree()that ensures that extracted files do not fall outside the target directory.1732a18: ExportedredactLogLinefunction to be able to use it in custom loggers and renamed it toredactWinstonLogLine.3b7930b: Add support for Bearer Authorization header / token-based auth at Git commands.cfa078e: TheZipArchiveResponsenow correctly handles corrupt ZIP archives.Before this change, certain corrupt ZIP archives either cause the inflater to throw (as expected), or will hang the parser indefinitely.
By switching out the
zipparsing library, we now write to a temporary directory, and load from disk which should ensure that the parsing of the.zipfiles are done correctly becausestreamingofzippaths is technically impossible without being able to parse the headers at the end of the file.770d3f9: The config propensureExistsnow applies to schema creation whenpluginDivisionModeis set toschema. This means schemas will no longer accidentally be automatically created whenensureExistsis set tofalse.29f782e: Updated dependency@types/luxonto^3.0.0.Updated dependencies
backstage/backstage (@backstage/backend-tasks)
v0.5.21Compare Source
Patch Changes
v0.5.20Compare Source
Patch Changes
v0.5.19Compare Source
Patch Changes
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.18Compare Source
Patch Changes
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.17Compare Source
v0.5.16Compare Source
v0.5.15Compare Source
Patch Changes
9aac2b0: Use--cwdas the firstyarnargument6707216: TheTaskScheduler.fromConfigmethod now accepts theLegacyRootDatabaseServiceinterface rather than the fullDatabaseManagerimplementation.b68248b: Updated dependencycronto^3.0.0.v0.5.14Compare Source
Patch Changes
v0.5.13Compare Source
Patch Changes
d8f488a: Allow tasks to run more often that the default work check interval, which is 5 seconds.0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.5.12Compare Source
Patch Changes
013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.v0.5.11Compare Source
Patch Changes
5db102b: Instrumentbackend-taskswith some counters and histograms for duration.backend_tasks.task.runs.count: Counter with the total number of times a task has been run.backend_tasks.task.runs.duration: Histogram with the run durations for each task.Both these metrics have come with
resulttaskIdandscopelabels for finer grained grouping.ddd76ac: Fix bug where backend tasks that are defined with HumanDuration are immediately triggered on application startupUpdated dependencies
v0.5.10Compare Source
Patch Changes
5db102b: Instrumentbackend-taskswith some counters and histograms for duration.backend_tasks.task.runs.count: Counter with the total number of times a task has been run.backend_tasks.task.runs.duration: Histogram with the run durations for each task.Both these metrics have come with
resulttaskIdandscopelabels for finer grained grouping.ddd76ac: Fix bug where backend tasks that are defined with HumanDuration are immediately triggered on application startupUpdated dependencies
v0.5.9Compare Source
v0.5.8Compare Source
Patch Changes
8fd9154: When starting a task that existed before, with a faster schedule than itpreviously had, the task will now correctly obey the faster schedule
immediately. Before this fix, the new schedule was only obeyed after the next
pending (according to the old schedule) run had completed.
62f448e: UsereadDurationFromConfigfrom the config package7460480: Avoid starting task janitor in tests.cfc3ca6: Changes needed to support MySQL814feee: Update to handle invalid luxon valuesv0.5.7Compare Source
Patch Changes
cfc3ca6: Changes needed to support MySQLv0.5.6Compare Source
v0.5.5Compare Source
Patch Changes
dfd1b6b: MakereadTaskScheduleDefinitionFromConfigproperly handle bad inputsv0.5.4Compare Source
Patch Changes
v0.5.3Compare Source
Patch Changes
v0.5.2Compare Source
Patch Changes
v0.5.1Compare Source
Patch Changes
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.0Compare Source
Minor Changes
1578276: add functionality to get descriptions from the scheduler for triggeringPatch Changes
f068519: Added the adapted query to mysql and sqlite3 databases to not returning warning on logs482dae5: Updated link to docs.v0.4.3Compare Source
Patch Changes
v0.4.2Compare Source
@backstage/create-app@0.3.0
Minor Changes
0101c7a: Add search plugin to default template for CLI created appsPatch Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
@backstage/techdocs-common@0.3.0
Minor Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
@backstage/plugin-techdocs-backend@0.5.0
Minor Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
Patch Changes
a8573e5]@backstage/cli@0.4.3
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json7d72f9b: Fix forapp.listen.hostconfiguration not properly overriding listening host.@backstage/core@0.4.2
Patch Changes
1dc445e: Update to use new plugin extension API342270e: Create AboutCard in core and use it in pagerduty and catalog plugind681db2]1dc445e]@backstage/core-api@0.2.7
Patch Changes
d681db2: Fix for GitHub and SAML auth not properly updating session state when already logged in.1dc445e: Introduce new plugin extension API1dc445e]@backstage/test-utils@0.1.6
Patch Changes
1dc445e: Update to use new plugin extension APId681db2]1dc445e]@backstage/plugin-catalog@0.2.8
Patch Changes
342270e: Create AboutCard in core and use it in pagerduty and catalog plugin19554f6]1dc445e]342270e]@backstage/plugin-catalog-backend@0.5.1
Patch Changes
5de26b9: Start warning about usage of deprecated location types, such asgithub30d6c78: Added configuration schema for the commonly used properties5084e50: Updated the config schema@backstage/plugin-github-actions@0.2.6
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.jsond681db2]1dc445e]342270e]1dc445e]@backstage/plugin-graphiql@0.2.3
Patch Changes
1dc445e: Update to use new plugin extension API1dc445e]342270e]@backstage/plugin-pagerduty@0.2.4
Patch Changes
342270e: Create AboutCard in core and use it in pagerduty and catalog plugin1dc445e]342270e]@backstage/plugin-scaffolder@0.3.5
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json1dc445e]342270e]@backstage/plugin-scaffolder-backend@0.3.6
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json33a82a7: GitLab preparer uses the right token (primarily the same one as the publisher, falling back to the integrations token)aed8f7f: Clearer error message when preparer or publisher type can't be determined.@backstage/plugin-techdocs@0.5.1
Patch Changes
d681db2]1dc445e]342270e]1dc445e]a8573e5]example-app@0.2.8
Patch Changes
19554f6]1dc445e]342270e]7d72f9b]example-backend@0.2.8
Patch Changes
7cfcd58: use node 14 for backend Dockerfile19554f6]33a82a7]5de26b9]30d6c78]5084e50]a8573e5]aed8f7f]v0.4.1Compare Source
Patch Changes
3fad4ed: Added a new staticTaskScheduler.forPluginmethod.b99c030: Minor internal refactor to avoid import cycle issue.v0.4.0Compare Source
Minor Changes
de8a975: Changed to use nativeAbortControllerandAbortSignalfrom Node.js, insteadof the one from
node-abort-controller. This is possible now that the minimumsupported Node.js version of the project is 16.
Note that their interfaces are very slightly different, but typically not in a
way that matters to consumers. If you see any typescript errors as a direct
result from this, they are compatible with each other in the ways that we
interact with them, and should be possible to type-cast across without ill
effects.
Patch Changes
b05dcd5: Move thezoddependency to a version that does not collide with other librariesbackstage/backstage (@backstage/cli)
v0.26.2Compare Source
Patch Changes
eeb226a: Updated dependencyrollupto^4.0.0.91192f4: Updated backend plugin template to work better with new backend systemcc371d6: Ignore transforming only onreact-use/lib, not wholereact-usein jest.** POTENTIAL BREAKAGE **
If your tests fail, please change to use path import from
react-use/esm/. It is also recommended to migrate fromreact-user/libimports toreact-use/esmUpdated dependencies
v0.26.1Compare Source
Patch Changes
eeb226a: Updated dependencyrollupto^4.0.0.cc371d6: Ignore transforming only onreact-use/lib, not wholereact-usein jest.** POTENTIAL BREAKAGE **
If your tests fail, please change to use path import from
react-use/esm/. It is also recommended to migrate fromreact-user/libimports toreact-use/esmUpdated dependencies
v0.26.0Compare Source
Minor Changes
0d72065: The backend devlopment server transpilation has been replaced with a simplified solution based on SWC, which is already the transpiler used for tests. This fixed an issue where never versions of thetsxdependency had a new contract for signalling dependencies, breaking watch mode. This change fixed file watches as well as enables sourcemaps.Patch Changes
fe1a55e: Extend option to minify generated code to thebackendpackage.b0875e5: Fixed a bug that could cause thebuild-workspacecommand to fail when invoked with--alwaysYarnPackenabled in environments with limited resources.bdf9ec1: New backend plugins with cli are now created using the new backend systemcadbb82: Added aEXPERIMENTAL_LAZY_COMPILATIONflag, which enables the experimental Webpack lazy compilation option in frontend builds.999224f: Bump dependencyminimatchto v91bd4596: Removed thets-nodedev dependency.8dce287: Fix prettier issues on default plugins & module templatesf86e34c: Removed unusedreplace-in-filedependency2398c7c: Updated dependency@spotify/prettier-configto^15.0.0.Updated dependency
@spotify/eslint-config-baseto^15.0.0.Updated dependency
@spotify/eslint-config-reactto^15.0.0.Updated dependency
@spotify/eslint-config-typescriptto^15.0.0.f4404e5: Add .ico import supportf39dfd3: Tweak the descriptions of the CLI templatesv0.25.2Compare Source
Patch Changes
d557d47: Added check for therepositoryfield in therepo fixcommand.b58673e: Upgrade jestc624938: Add experimental support for an optionalpublicapp entry point that lets users sign-in before being able to access the full app.c52e7d5: Makehttp://localhost:3000the default base URL for serving locally, and/the default public path for built apps. The app build no longer requires any configuration values to be present.9a96ef2: Updated dependencyvite-plugin-node-polyfillsto^0.21.0.6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.2f1f8fd: Updated dependencyesbuild-loaderto^4.0.0.fd20d5b: Updated dependencyeslint-config-prettierto^9.0.0.acd2860: Updated dependencyvite-plugin-node-polyfillsto^0.19.0.40c27f3: Updated dependencyeslint-webpack-pluginto^4.0.0.6ba64c4: Updated dependencycommanderto^12.0.0.ba56063: Updated dependencyfork-ts-checker-webpack-pluginto^9.0.0.1cae748: Updated dependencygit-url-parseto^14.0.0.52ae6b9: Updated dependencyesbuildto^0.20.0.404e82b: Updated dependencyeslint-plugin-deprecationto^2.0.0.5c05f8a: Harmonize the package naming and allow custom prefix35725e2: Updated dependencies in frontend plugin templatesc7259dc: Updated the backend module template to make the module instance the package default export.08804c3: Fixed an issue that would cause an invalid__backstage-autodetected-plugins__.jsto be written when using experimental module discovery.v0.25.1Compare Source
Patch Changes
b6b15b2: Use sha256 instead of md5 in build script cache key calculationMakes it possible to build on FIPS nodejs.
Updated dependencies
v0.25.0Compare Source
Minor Changes
3834067: Updates the ESLint config to ignore issues created by generated files in**/src/generated/**.Patch Changes
32018ff: Enable thetsxloader to work on Node 18.19 and up0ffee55: Toned down the warning message when git is not foundc6f3743: Added a warning when starting a standalone backend plugin that hasn't been updated to the new backend system.3e358b0: Added deprecation warning for React Router v6 beta, please make sure you have migrated your apps to use React Router v6 stable as support for the beta version will be removed. See the migration tutorial for more information.219d7f0: Updating template generation for scaffolder module8cda3c7: Tweaked Node.js version check for when to use the new module register API with the new backendpackage startcommand.a3edc18: Updated dependencyvite-plugin-node-polyfillsto^0.17.0.627554e: Updated dependency@rollup/plugin-node-resolveto^15.0.0.c07cee5: Updated dependency@rollup/plugin-jsonto^6.0.0.bd586a5: Updated dependencybfjto^8.0.0.8056425: Updated dependency@typescript-eslint/eslint-pluginto6.12.0.017c425: Updated dependency@typescript-eslint/eslint-pluginto6.11.0.2565cc8: Updated dependency@rollup/plugin-commonjsto^25.0.0.33e96e5: Switched the@typescript-eslint/eslint-plugindependency back to using a^version range.0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.24.0Compare Source
Minor Changes
8db5c3c: Removed support for thepublishConfig.alphaTypesand.betaTypesfields that were used together with--experimental-type-buildto generate/alphaand/betaentry points. Use theexportsfield to achieve this instead.4e36abe: Remove support for the deprecated--experimental-type-buildoption forpackage build.Patch Changes
4ba4ac3: Switch from using deprecated@esbuild-kit/*packages to usingtsx. This also switches to using the new module loaderregisterAPI when available, avoiding the experimental warning when starting backends.cd80ebb: Updated dependencyvite-plugin-node-polyfillsto^0.16.0.4aa43f6: Updated dependencycross-fetchto^4.0.0.971dcba: Updated dependency@typescript-eslint/eslint-pluginto6.10.0.6bf7561: The experimental package detection will now ignore packages that don't makepackage.jsonavailable.e14cbf5: AddedEXPERIMENTAL_VITEflag for using vite as dev server instead of Webpack7cd3439: Ignorestdinwhen spawning backend child process for thestartcommand. Fixing an issue where backend startup would hang.v0.23.1Compare Source
v0.23.0Compare Source
Minor Changes
8defbd5: Update typescript-eslint to 6.7.x, adding compatibility with TypeScript 5.2.This includes a major update on typescript-eslint, you can see the details in the release notes.
7077dbf: BREAKING The new backend start command that used to be enabled by settingEXPERIMENTAL_BACKEND_STARTis now the default. To revert to the old behavior setLEGACY_BACKEND_START, which is recommended if you haven't migrated to the new backend system.This new command is no longer based on Webpack, but instead uses Node.js loaders to transpile on the fly. Rather than hot reloading modules the entire backend is now restarted on change, but the SQLite database state is still maintained across restarts via a parent process.
Patch Changes
9468a67: In frontend builds and testsprocess.env.HAS_REACT_DOM_CLIENTwill now be defined ifreact-dom/clientis present, i.e. if using React 18. This allows for conditional imports ofreact-dom/client.6815803: Fix for the new backendstartcommand to make it work on Windows.4f16e60: Request slightly smaller pages of data from GitHub21cd3b1: Added a template for creatingnode-librarypackages withyarn new.d0f26cf: Fixed an issue where the new backend start command would not gracefully shut down the backend process on Windows.1ea20b0: Updated dependency@typescript-eslint/eslint-pluginto6.7.5.2ef6522: Support for the.icon.svgextension has been deprecated and will be removed in the future. The implementation of this extension is too tied to a particular version of MUI and the SVGO, and it makes it harder to evolve the build system. We may introduce the ability to reintroduce this kind of functionality in the future through configuration for use in internal plugins, but for now we're forced to remove it.To migrate existing code, rename the
.icon.svgfile to.tsxand replace the<svg>element with<SvgIcon>from MUI and add necessary imports. For example:b9ec934: The scaffolder-module template now recommends usage ofcreateMockDirectoryinstead ofmock-fs.de42eeb: Bumped dev dependencies@types/nodeandmock-fs.425203f: Fixed recursive reloading issues of the backend, caused by unwanted watched files.3ef18f8: Explicitly setexports: 'named'for CJS builds, ensuring that they have e.g.exports["default"] = catalogPlugin;7187f29: The experimental package discovery will now always use the package name for include and exclude filtering, rather than the full module id. Entries pointing to a subpath export will now instead have anexportfield specifying the subpath that the import is from.Updated dependencies
v0.22.14Compare Source
v0.22.13Compare Source
Patch Changes
04eabd2: Added the ability to specify the listen address for the--inspectand--inspect-brkcommand. You can now set theipand port of theinspectandinspectBrkby adding for example--inspect=0.0.0.0:9229278d932: Added the ability to create a plain backend module with thenewcommand.4d5eeec: Add ESM loader for the experimental backend start command.3494c50: Added a newrepo fixcommand that fixes auto-fixable problems in all packages. Initially the command fixes package export declarations, as well as marks all non-bundled frontend packages as side-effect free. Marking packages as free of side-effects can drastically reduce the Webpack bundle size.f36113c: Add experimental support for frontend package discovery.a23fce7: Fixed a bug where package exports entry points could not be.tsxfiles.8cec766: Removed@types/nodedependencyea77949: Updated dependencyrun-script-webpack-pluginto^0.2.0.4af4def: When runningversion:bumpit will now log duplicates instead of throwing an error71d4368: Added support for thedev/indexentry point for backend plugins and modules.956d226: Add"sideEffects": falsetopackage.jsonin frontend package templates. This can be added to existing packages using the newyarn fixcommand.cd73315: Removed the experimentalpackage fixcommand that was used to automatically add dependencies topackage.json, but has since been replaced by theno-undeclared-importsrule from@backstage/eslint-plugin.219b46a: Include default alpha export during package detectionv0.22.12Compare Source
Patch Changes
278d932: Added the ability to create a plain backend module with thenewcommand.71d4368: Added support for thedev/indexentry point for backend plugins and modules.v0.22.11Compare Source
v0.22.10Compare Source
Patch Changes
3f67cef: Reload the frontend when app config changescebbf8a: Enable to print the config schema not merged with the--no-mergeflag5c28ebc: Updated dependencyesbuildto^0.19.0.971bdd6: Bumped internalnodemondependency.v0.22.9Compare Source
Patch Changes
6adb6f4: Fixed the--alwaysYarnPackflag on thebackstage-cli build-workspacecommand.4edd1ef: semver upgrade to 7.5.3ff45cb5: Updated dependencyesbuildto^0.18.0.8174cf4: Fixing MUI / Material UI referencesv0.22.8Compare Source
Patch Changes
314493f: Introduced the--alwaysYarnPackflag onbackstage-cli build-workspace, which can be passed in cases where accuracy of workspace contents is more important than thespeed with which the workspace is built. Useful in rare situations where
yarn packandnpm packproduce different results.7554059: Updated example component for a newly scaffolded app.5d692f7: Make sure to include afetchenvironment forjsdominjesttests6816352: Add discovery feature to the onboard cli command.20b7da6: Enforcing Material UI v5 specific linting to minimize bundle size.v0.22.7Compare Source
Patch Changes
473db60: Enable strict config checking duringbackstage-cli config:checkwith the new--strictoption which will surface schema errors.d548886: Deprecated the use of React 16v0.22.6Compare Source
Patch Changes
24432ae: Fix the build for packages with multiple entry points to avoid duplicated modules.8075b67: When building a backend package with dependencies any--config <path>options will now be forwarded to any dependent app package builds, unless the build script in the app package already contains a--configoption.79e91d4: Support importing.mdfiles in build loader3156b0d: Internal refactor to move many internal utilities to the new@backstage/cli-nodepackage.b9839d7: Fixed backend start command on Windows by removing the use of platform dependent path joins.1e4f5e9: Bumpzodandzod-to-json-schemadependencies.29ba826: Updated dependency@material-ui/labto4.0.0-alpha.61.9bbb00d: Updated dependency@swc/helpersto^0.5.0.b588ab7: Ensure that thepackage prepackcommand and backend bundling uses posix paths inpackage.jsonon all OSes.c07c3b7: Addonboardcommand. While still in development, this command aims to guide users in setting up their Backstage App.e0c6e8b: Update peer dependenciesv0.22.5Compare Source
v0.22.4Compare Source
Patch Changes
1ad8d88: Fixed a bug where additional backend package entry points where not properly marked as internal during local development.2011b86: Added templates for new plugin Web and Node.js libraries.867f475: Updated the ESLint plugin configuration that is enabled throughyarn start --checkto only pick up valid source files.b4cd145: Added a newmigrate package-exportscommand that synchronizes package exports fields in allpackage.jsons.9bf50a3: Bumped themswversion in templates to 1.0.08bf2494: Adjust express dependencies to be the same as the rest of the project1727184: Updated frontend plugin template to use some more recent features4b49984: Updated dependencydelto^7.0.0.52b0022: Updated dependencymswto^1.0.0.a11b9a2: Keep custom exports entry points in package.json482dae5: Updated link to docs.v0.22.3Compare Source
v0.22.2Compare Source
Patch Changes
561df21: Thebackstage-cli repo testcommand now sets a default Jest--workerIdleMemoryLimitof 1GB. If needed to ensure that tests are not run in band,--maxWorkers=2is set as well. This is the recommended workaround for dealing with Jest workers leaking memory and eventually hitting the heap limit.2815981: Show module name causing error during builddd8a9af: Replaced several monorepo lint rules with new rules from@backstage/eslint-plugin. See the README for a full list of rules.a9c50af: Fixed Webpack loader patterns so that they properly match the file suffix only.66cf22f: Updated dependencyesbuildto^0.17.0.6d3abfd: Switch to inline source maps for test transpilation, simplifying editor setups.90616df: Added an experimental mode for thepackage startcommand for backend packages. Enabled by settingEXPERIMENTAL_BACKEND_START.v0.22.1Compare Source
Patch Changes
04eabd2: Added the ability to specify the listen address for the--inspectand--inspect-brkcommand. You can now set theipand port of theinspectandinspectBrkby adding for example--inspect=0.0.0.0:9229278d932: Added the ability to create a plain backend module with thenewcommand.4d5eeec: Add ESM loader for the experimental backend start command.3494c50: Added a newrepo fixcommand that fixes auto-fixable problems in all packages. Initially the command fixes package export declarations, as well as marks all non-bundled frontend packages as side-effect free. Marking packages as free of side-effects can drastically reduce the Webpack bundle size.f36113c: Add experimental support for frontend package discovery.a23fce7: Fixed a bug where package exports entry points could not be.tsxfiles.8cec766: Removed@types/nodedependencyea77949: Updated dependencyrun-script-webpack-pluginto^0.2.0.4af4def: When runningversion:bumpit will now log duplicates instead of throwing an error71d4368: Added support for thedev/indexentry point for backend plugins and modules.956d226: Add"sideEffects": falsetopackage.jsonin frontend package templates. This can be added to existing packages using the newyarn fixcommand.cd73315: Removed the experimentalpackage fixcommand that was used to automatically add dependencies topackage.json, but has since been replaced by theno-undeclared-importsrule from@backstage/eslint-plugin.219b46a: Include default alpha export during package detectionv0.22.0Compare Source
Minor Changes
736f893: The Jest configuration that was previously enabled withBACKSTAGE_NEXT_TESTSis now enabled by default. To revert to the old configuration you can now instead setBACKSTAGE_OLD_TESTS.This new configuration uses the
babelcoverage provider rather thanv8. It used to be thatv8worked better when using Sucrase for transpilation, but now that we have switched to SWC,babelseems to work better. In addition, the new configuration also enables source maps by default, as they no longer have a negative impact on code coverage accuracy, and it also enables a modified Jest runtime with additional caching of script objects.Patch Changes
91d050c: changed tests created by create-plugin to follow eslint-rules best practices particularly testing-library/prefer-screen-queries and testing-library/render-result-naming-convention43b2b9c: Removed the unused dependency on@sucrase/jest-plugin.dd72114: Updated Jest coverage configuration to only apply either in the root project or package configuration, depending on whether repo or package tests are run.5850ef9: Fix webpack dev server issue where it wasn't servingindex.htmlfrom correct endpoint on subsequent requests.b05dcd5: Move thezoddependency to a version that does not collide with other libraries459a345: Bumpmswversion in default plugin/app templatesc27eabe: Adds new web-library package option when generating a new plugin8fffe42: JSX and React Fast Refresh transforms are no longer enabled when bundling backend code.309f2da: Updated dependencyesbuildto^0.16.0.ee14bab: Updated dependencyminimatchto5.1.1and switch version range to^.3280711: Updated dependencymswto^0.49.0.ed0cf59: Updated dependency@rollup/plugin-commonjsto^23.0.0.16b7c2f: Updated dependency@rollup/plugin-yamlto^4.0.0.086c0bb: Updated dependency@rollup/plugin-jsonto^5.0.0.8015ff1: Tweaked wording to use inclusive terminologyd9d9a7a: Removed all copyright notices from package templates.8e0358e: Added--skip-installparameter tobackstage-cli versions:bumpv0.21.1Compare Source
Released a new
@backstage/plugin-config-schemaplugin that is used to show the config schema in a reference documentation format. It's intended for integrators rather than end users, and the idea is to also hook this up to a CLI command that allows browsing of the local schema.v0.21.0Compare Source
Minor Changes
7539b36: Added a new ESLint rule that restricts imports of Link from @material-uiThe rule can be can be overridden in the following way:
384eaa2: Switchedtsconfig.jsonto target and supportES2021, in line with the bump to Node.js 16 & 18.Patch Changes
e52d6ad: Updated thebackstage-cliso that thelist-deprecationscommand is visible and also removed the "[EXPERIMENTAL]" tag.88f99b8: Bumpedtardependency to^6.1.12in order to ensure Node.js v18 compatibility.df21bbd: Removed googleAnalyticsTrackingId configSchema.286d474: Minor update to theindex.htmltemplate that updates the comment at the end to be more accurate.4c16213: The built-in Jest configuration now always uses the Jest environments that are bundled with the CLI by default. This avoids a situation where Jest potentially picks up an incompatible version of the environment package from a different dependency in the project.4091c73: Updated@swc/coreto version 1.3.9 which fixes a.tsxparser bug969a844: Updated dependencyesbuildto^0.15.0.9c767e8: Updated dependency@svgr/plugin-jsxto6.5.x.Updated dependency
@svgr/plugin-svgoto6.5.x.Updated dependency
@svgr/rollupto6.5.x.Updated dependency
@svgr/webpackto6.5.x.v0.20.0Compare Source
Minor Changes
f368ad7: BREAKING: Bumpedjest,jest-runtime, andjest-environment-jsdomto v29. This is up from v27, so check out both the v28 and v29 (later here) migration guides.Particular changes that where encountered in the main Backstage repo are:
jest.useFakeTimers('legacy')is nowjest.useFakeTimers({ legacyFakeTimers: true }).withLogCollectorfrom@backstage/test-utilsare now objects with adetailproperty rather than a string.Patch Changes
78d5eb2: Tweak the Jest Caching loader to only operate when inwatchmode9c59530: Normalize on winston version ^3.2.124b4014: Treat files in__testUtils__and__mocks__directories as test files for lintingpurposes.
Updates the parts of the eslint configuration generator that specify which files
should be treated as test code to include any files under two additional
directories:
__mocks__: this is the directory used by Jest0 for mock code.__testUtils__: a suggested location for utility code executed only whenrunning tests.
3e30910: Updated fallback versions of dependencies in all templates.292a088: Added a newrepo testcommand.ba63cae: Updated lockfile parsing to have better support for Yarn 3.2d3a5f0: Useresponse.jsonrather thanresponse.sendwhere appropriate, as outlined inSECURITY.md2dddb32: Switched the Jest transform for YAML files to use a custom one available at@backstage/cli/config/jestYamlTransform.js.a541a3a: Switch to upfront resolution ofswc-loaderin Webpack config.cfb3598: Removedtsxandjsxas supported extensions in backend packages. For mostrepos, this will not have any effect. But if you inadvertently had added some
tsx/jsxfiles to your backend package, you may now start to seecode: 'MODULE_NOT_FOUND'errors when launching the backend locally. The reason forthis is that the offending files get ignored during transpilation. Hence, the
importing file can no longer find anything to import.
The fix is to rename any
.tsxfiles in your backend packages to.tsinstead,or
.jsxto.js.Updated dependencies
v0.19.0Compare Source
Minor Changes
1fe6823: Updated dependencyeslint-plugin-jestto^27.0.0.Note that this major update to the Jest plugin contains some breaking changes.
This means that some of your tests may start seeing some new lint errors. Read
about them
here.
These are mostly possible to fix automatically. You can try to run
yarn backstage-cli repo lint --fixin your repo root to have most or all of themcorrected.
Patch Changes
8d886dd: Thecreate-pluginandcreatecommands have both been deprecated in favor of a newnewcommand. Thenewcommand is functionally identical tocreate, but the new naming makes it possible to use as yarn script, sinceyarn createis reserved.cc63eb8: Sort entries in skeleton.tar.gz for better docker layer caching5480536: Deprecated theplugin:diffcommand. If you wish to keep running similar checks in your project we recommend using bespoke scripts. A useful utility for such scripts is@manypkg/get-packages, which helps you enumerate all packages in a monorepo.513b4dd: Theversions:bumpcommand will now update dependency ranges inpackage.json, even if the new version is within the current range.221e951: Added support for custom certificate for webpack dev server.934cc34: Avoid validating the backend configuration schema when loading static configuration for building the frontend.3d4f5da: Remove use of deprecated trimLeft/trimRight817f319: Added a newmigrate react-router-depscommand to aid in the migration to React Router v6 stable.742cb4f: Fix issue when using.jsxfiles inside testse7600bd: Tweaked workspace packaging to not rewrite existingpackage.jsonfiles.6ae0f6a: Switch outsucraseforswcfor transpilation.sucraseis a little more relaxed when it comes to supporting the ways of mocking injest. You might have to make some changes to your tests to meet thejeststandard and spec if your tests seems to start failing.Mocks that look like this are invalid, and they will throw a reference error in line with the
jestdocumentation here on example 3You might need to update these mocks to look a little like the following to defer the call to the
jest.fn()spy until the mock is called.Also, imports are immutable. So it means that you might get some errors when trying to use
jest.spyOnwith starred imports. You might see an error like this:This happens when you try to do
import * as something from './something'and thenjest.spyOn(something, 'test). You will need to add ajest.mockcall to mock out the required starred import to returnjest.fn()functions from the start. Something like this fixes the above test:You can also remove any occurrence of
hot(App)and any import ofreact-hot-loaderif you're using the that package locally, as all this has now been replaced with React Refresh which you will get out of the box with the new CLI.Note If you're experiencing difficulties with running tests after the migration, please reach out to us on Discord to see if we can help, or raise an issue. But in the meantime you can switch back to the existing behaviour by using the following config in your root
package.json.1cb078a: Fixed a misconfiguration where all modules where treated as ESM by the React Refresh plugin for Webpack.1fd4f27: Removed internal dependencies on Lerna. It is now no longer necessary to have Lerna installed in a project to use all features of the Backstage CLI.667d917: Updated dependencymswto^0.47.0.87ec2ba: Updated dependencymswto^0.46.0.bf5e903: Updated dependencymswto^0.45.0.33fbd9f: Updated dependency@types/minimatchto^5.0.0.68c2697: Added a newbackstage-cli repo cleancommand that cleans the repo root and runs the clean script in all packages.7d47def: Added dependency on@types/jestv27. The@types/jestdependency has also been removed from the plugin template and should be removed from any of your own internal packages. If you wish to override the version of@types/jestorjest, use Yarn resolutions.a7e82c9: Updatedversions:bumpcommand to be compatible with Yarn 3.Updated dependencies
v0.18.1Compare Source
Patch Changes
d45bbfe: Linting is now ignored for any.eslintrc.*files, not just.eslintrc.js.72c228f: Fixed a bug whereNODE_ENVwas not set in the environment when starting the backend in development mode. It has always been the case that Webpack transformedNODE_ENVwhen running in development mode, but this did not affect dependencies innode_modulesas they are treated as external.a539564: Added Backstage version to output ofyarn backstage-cli infocommandfd68d6f: Added resolution of.jsonand.wasmfiles to the Webpack configuration in order to match defaults.94155a4: Updated dependencies@svgr/*to6.3.x.v0.18.0Compare Source
Minor Changes
96a82d9: BREAKING: Removed the following deprecated package commands:app:build- Usepackage buildinsteadapp:serve- Usepackage startinsteadbackend:build- Usepackage buildinsteadbackend:bundle- Usepackage buildinsteadbackend:dev- Usepackage startinsteadplugin:build- Usepackage buildinsteadplugin:serve- Usepackage startinsteadbuild- Usepackage buildinsteadlint- Usepackage lintinsteadprepack- Usepackage prepackinsteadpostpack- Usepackage postpackinsteadIn order to replace these you need to have migrated to using package roles.
Patch Changes
8664021: Upgrade@rollup/plugin-node-resolveto^13.0.6d2256c0: Fixwebpack-dev-serverdeprecations.a70869e: Updated dependencymswto^0.43.0.72622d9: Updated dependencyyamlto^2.0.0.e661242: Updated dependencyrun-script-webpack-pluginto^0.1.0.8006d0f: Updated dependencymswto^0.44.0.e8ed804: Updated dependency@spotify/prettier-configto^14.0.0.Updated dependency
@spotify/eslint-config-baseto^14.0.0.Updated dependency
@spotify/eslint-config-reactto^14.0.0.Updated dependency
@spotify/eslint-config-typescriptto^14.0.0.e662b57: Updated dependency@octokit/requestto^6.0.0.f6b6fb7: Thetestcommand now ensures that all IO is flushed before exiting when printing--help.backstage/backstage (@backstage/core-components)
v0.14.3Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.14.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.14.1Compare Source
Patch Changes
2ff3e6e: The translation support for theLinkcomponent has been removed for now, in order to avoid broad breakages of tests in existing projects where the component is tested without being wrapped in an API provider.2d06e4b: Move the text-transform styling on BackstageTableHeader from inline styling towithStylesso it can be customised easier5c271fa: Removed inline styling in breadcrumbs and replaced with a theme reachable class of BreadcrumbsCurrentPageff33ee2: Removed hardcoded font-family on select inputff7e126: Support i18n for core components7854120: Create a component abstraction to consume system icons.ce73c3b: Removed the inline color from select icon to allow it to be colored via a theme0c9d5ea: Updated MUI imports for core-components to not be top level90d08b0: Updated dependencyreact-idle-timerto5.7.2.a8f7904:SignInPage's'guest'provider now supports the@backstage/plugin-auth-backend-module-guest-providerpackage to generate tokens. It will continue to use the old frontend-only auth as a fallback.0a8a1e9: Fix a spacing issue for the SidebarSubmenu in case a SidebarScrollWrapper is used that made it hard to reach the SidebarSubmenuaa1c88d: Deprecate thecustomStylesprop for theAvatarcomponent in favour of theclassesprop.v0.14.0Compare Source
Minor Changes
281e8c6: BREAKING: Removed theSidebarIntrocomponent as it was providing instructions for features that do not exist, along withIntroCard. If you were relying on this component and want to keep using it you can refer to the original implementations ofSidebarIntroandIntroCard.Patch Changes
3e1c6e2: Added possibility to show arrow heads for graph edges for better understandability.In order to show arrow heads in the catalog graph page, add
showArrowHeadsattribute toCatalogGraphPagecomponent(typically in
packages/app/src/App.tsx):In order to show arrow heads in entity graphs, add
showArrowHeadsattribute toEntityCatalogGraphCardcomponents(typically multiple occurrences in
packages/app/src/components/catalog/EntityPage.tsx):8fe56a8: Widen@types/reactdependency range to include version 18.7f11009: Added stack trace display toErrorPageand updated existing refs09cedb9: Updated dependency@react-hookz/webto^24.0.0.214f2da: Fix invalid HTTP status code 501 in Error PageUpdated dependencies
v0.13.10Compare Source
Patch Changes
d625f66: Fixed bug in Link where it was possible to select and copy a hidden element into clipboard6878b1d: Removed unnecessaryhistoryandimmerdependencies.v0.13.9Compare Source
Patch Changes
e8f2ace: Added a new/testUtilssub-path that initially exports amockBreakpointhelper.381ed86: Add missing export for IconLinkVertical5c8a3e3: Minor improvements toTablecomponent.752df93: Fixes a problem where theLogViewerwas not able to handle very large logs4d9e3b3: Register component overrides in the globalOverrideComponentNameToClassKeysprovided by@backstage/theme. This will in turn will provide component style override types forcreateUnifiedTheme.07dfdf3: Updated dependencylinkifyjsto4.1.3.a518c5a: Updated dependency@react-hookz/webto^23.0.0.f291757: Updatelinkify-reactto version4.1.3175d86b: Fixed an issue where theonChangeprop withinHeaderTabswas triggering twice upon tab-switching.0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.13.8Compare Source
Patch Changes
81c8db2: FixRoutedTabsso that it does not explode without tabs.eb817ee: Fix spacing inconsistency with links and labels in headersf28c117: Add a possibility to use a formatter on a warning panel. Applied it for a scaffolder template6c2b872: Add official support for React 18.e07570a: Fixed an issue causing theSelectcomponent to show empty chips when some of the selected values did not match any item7bdc1b0: Fixed compatibility with Safari <16.3 by eliminating RegEx lookbehind inextractInitials.This PR also changed how initials are generated resulting in John Jonathan Doe => JD instead of JJ.
66071b4: Make theoptions.titleFormatprop of<StructuredMetadataTable />apply to all keys including nested ones. Previously, this option would only apply to the root keys of themetadataprop.Document and improve the props of
<StructuredMetadataTable />. Previously, theoptionsprop wasany.71c97e7: Fixed the type declaration ofDependencyGraphProps, thedefsprop now expectsJSX.Elements.0c5b786: Reverting theMissingAnnotationEmptyStatecomponent due to cyclical dependency. This component is now deprecated, please use the import from@backstage/plugin-catalog-reactinstead to use the new functionality4b7d341: Updated dependencylinkify-reactto4.1.2.0ef2442: Updated dependencylinkifyjsto4.1.2.4aa43f6: Updated dependencycross-fetchto^4.0.0.Updated dependencies
v0.13.7Compare Source
Patch Changes
81c8db2: FixRoutedTabsso that it does not explode without tabs.6c2b872: Add official support for React 18.7bdc1b0: Fixed compatibility with Safari <16.3 by eliminating RegEx lookbehind inextractInitials.This PR also changed how initials are generated resulting in John Jonathan Doe => JD instead of JJ.
71c97e7: Fixed the type declaration ofDependencyGraphProps, thedefsprop now expectsJSX.Elements.Updated dependencies
v0.13.6Compare Source
Patch Changes
4eab5cf: TheTabbedLayoutcomponent will now also navigate when clicking the active tab, which allows for navigation back from any sub routes.0b55f77: Removed some unused dependencies8a15360: Fixed overflowing messages inWarningPanel.997a718: Changed SupportButton menuitems to support text wrap0296f27: Fixed the type declaration ofDependencyGraphProps, thedefsprop now expectsJSX.Elements.9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.16126db: Change overlay header colors in the mobile menu to use navigation color from the themed19a827: MissingAnnotationEmptyState component can now dynamically generate a YAML example based off the current entity being used.v0.13.5Compare Source
Patch Changes
0c99076: Fixed an issue causingStructuredMetadataTableto crash in case metadata containednullvalues.406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.9b74166: Added<AutoLogout>component which introduces an optional automatic logout mechanism on user inactivity1170276: Minor internal tweak to handleclassnamesupdate8cec766: Removed@types/nodedependencydb92d12: Updated dependencyrc-progressto3.5.1.47782f4: Add loading indicator to Table3d63e60: Internal restructure to avoid circular importsv0.13.4Compare Source
Patch Changes
3d86be9: Prefer simpletheme.spacingwithout string interpolationv0.13.3Compare Source
Patch Changes
7e0f558: TheSkip to contentbutton on click focuses on the main article tag and skips theh1tag. Users are not able to identify which page they are on currently. Now it's changed the behaviour of the button and focuses on theh1tag on the page.68531cc: Break some internal circular import chains4722c94: Parse unicode characters in name for avatar component015439b: Updated dependencyrc-progressto3.4.2.8174cf4: Fixing MUI / Material UI references4317b1c: Remove zooming in restrictions in the catalog grapha011d23: Fix keyboard navigation & focus highlight on Select component.v0.13.2Compare Source
Patch Changes
4e697e8: Add resource utilization to Pod Drawer78cbb8e: Enhance the sidebar item accessibility by using appropriate header semantics.66ae4d8: Addedexactprop toSidebarSubmenuItemwhich causes it to only highlight if the current location is an exact match.83bdc3a: Replaced usages oftheme.palette.theme.hintwiththeme.palette.text.secondaryas it has been removed in Material UI v5b4cc4b1: SupportButton auto focus first item when opened.e33beb1: Make the documentation pages printable (also handy for exporting to PDF)v0.13.1Compare Source
Patch Changes
d625f66: Fixed bug in Link where it was possible to select and copy a hidden element into clipboard6878b1d: Removed unnecessaryhistoryandimmerdependencies.v0.13.0Compare Source
Minor Changes
01cd4e2: BREAKING: RemovingTabscomponent fromcore-componentsas it is neither used in the core Backstage app nor in the monorepo plugins. If you are using this component in your instance please consider replacing it with the Material UITabscomponent like the following:Patch Changes
d0befd3: Fixed a bug that could prevent auth from working when using theguestorcustomauth providers.67140d9: Upgradereact-virtualized-auto-sizer´ to version^1.0.11`6e0b714: Switched internal declaration ofDependencyGraphTypesto usenamespace.c8779cc: UpdatedLogLinecomponent, which is used by theLogViewer, to turn URLs into clickable links. This feature is on by default7908d72: Introduce a new global config parameter,enableExperimentalRedirectFlow. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.1e4f5e9: Bumpzodandzod-to-json-schemadependencies.29ba826: Updated dependency@material-ui/labto4.0.0-alpha.61.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)303c2c3: AllowcloseButtoncolor inDismissableBannerto be configurable (via.theme.palette.banner.closeButtonColor)7e60bee: Split theBackstageSidebarstyledrawerclass, such that thewidthproperty is in a separatedrawerWidthclass instead. This makes it such that you can style thedrawerclass in your theme again.7245e74: Fixed the font color onBackstageHeaderLabelto respect the active page theme.e0c6e8b: Update peer dependenciesv0.12.5Compare Source
Patch Changes
8bbf95b: Button labels in the sidebar (previously displayed in uppercase) will be displayed in the case that is provided without any transformations.For example, a sidebar button with the label "Search" will appear as Search, "search" will appear as search, "SEARCH" will appear as SEARCH etc.
This can potentially affect any overriding styles previously applied to change the appearance of Button labels in the Sidebar.
cb8ec97: Change black & white colors to be theme awarec10384a: Switch to usingLinkButtoninstead of the deprecatedButton52b0022: Updated dependencymswto^1.0.0.e1aae2f: Updated thearia-labelof theHeaderTabscomponent.6a51a49: Fix bug where<Table />component would not take into account header styles defined incolumns[*].headerStyle.fa004f6: Use media queries to change layout instead ofisMobileprop inBackstagePagecomponentv0.12.4Compare Source
Patch Changes
68ce7d0: Added aria labels on the support button and sidebar5637ebe: Added a global override forwindow.openthat helps prevent security vulnerabilities.910015f: The Button component has been deprecated in favor of the LinkButton component20840b3: Adds new type, TableOptions, extending Material Table Options.e81a6e0: Updated Link URL validation to be more strict.85b04f6: Internal refactor to not use deprecatedsubstr66e2aab: Navigation items in mobile sidebar now have aria label.v0.12.3Compare Source
Patch Changes
f2ea446: Applied fix from v1.9.180ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.f231465: Ensure that the "Custom User" sign-in makes use of supplied custom tokens, if anyv0.12.2Compare Source
Patch Changes
v0.12.1Compare Source
Patch Changes
a236a88: Update sidebar icon alignmentd3fea4a: Internal fixes to avoid implicit usage of globalsb05dcd5: Move thezoddependency to a version that does not collide with other librariesea4a5be: Create a variable for minimum height and add a prop named 'fit' for determining if the graph height should grow or be contained.2e701b3: Internal refactor to usereact-router-domrather thanreact-router.d2e3bf6: Made AlertDisplay not crash on undefined messages64a579a: Add items prop to SupportButton. This prop can be used to override the items that would otherwise be grabbed from the config.5d30583: Addreact/forbid-elementslinter rule for button, suggest Material UIButton3280711: Updated dependencymswto^0.49.0.19356df: Updated dependencyzen-observableto^0.9.0.c3fa90e: Updated dependencyzen-observableto^0.10.0.5fb6d5e: Updated dependency@react-hookz/webto^19.0.0.17a8e32: Updated dependencyrc-progressto3.4.1.146378c: Updated dependency@react-hookz/webto^20.0.0.dfc8edf: Internal refactor to avoid usage of deprecated symbols.8015ff1: Tweaked wording to use inclusive terminology8306875: Sync components in @backstage/core-components with the Component Design Guidelines1ae86ab: Added an option to allow theAlertMessageto be self-closing. This is done with a newdisplayproperty that is set totransienton theAlertMessagewhen triggering a message to theAlertApi. The length of time that these transient messages stay open for can be set using thetransientTimeoutMsprop on theAlertDisplayin theApp.tsx. Here is an example:The above example will set the transient timeout to 2500ms from the default of 5000ms
16e31e6: InfoCard - Remove subheader container when there is not a subheader or icona5a2d12: Added option to pass additional headers to<ProxiedSignInPage />, which are passed along with the request to the underlying provider91bba69: Internal refactor to remove deprecated symbols.Updated dependencies
v0.12.0Compare Source
Minor Changes
fb3733e: BREAKING: Removed theHomepageTimeras it has been replaced by theHeaderWorldClockin the Home plugin and was deprecated over a year ago.Patch Changes
5f695c2: Set thesearchTooltipto "Filter" to follow how thesearchPlaceholderis set making this more consistentf36127f: Add optional step to SimpleStepperb4fb5c8: MissingAnnotationEmptyState now accepts either a string or an array of strings to support multiple missing annotations.7573b65: Internal refactor of imports to avoid circular dependencies858986f: Disable base path workaround inLinkcomponent when React Router v6 stable is used.f905853: Prefer usingLinkfrom@backstage/core-componentsrather than material-UI.v0.11.2Compare Source
Patch Changes
bde1e8c: Addedcurveprop to theDependencyGraphcomponent to select the type of layout882101c: Deep-import LightAsync component to improve module-import speed0d0f30d: Fixed layout for core-components docs where table was broken by splitting with code samplev0.11.1Compare Source
Patch Changes
817f319: Updated React Router dependencies to be peer dependencies.d3737da: ExportHeaderActionMenuand expose defaultTableicons viaTable.icons7d47def: Removed dependency on@types/jest.b29c44d: Adds code to generate ids for headers parsed through the MarkdownContent component.37e8c5e: TheRoutedTabscomponent has been updated to be compatible with React Router v6 stable.667d917: Updated dependencymswto^0.47.0.87ec2ba: Updated dependencymswto^0.46.0.bf5e903: Updated dependencymswto^0.45.0.13f23f6: Allow custom images in the empty state component023d14c: Fix overflow bug on MicDrop image for 404 page by moving the image and making it relative rather than absolutec8bb0ff: Minor cleanup of the public API surface to reduce the number of warningsv0.11.0Compare Source
Minor Changes
d0eefc4: Made thetoprop ofButtonandLinkmore strict, only supporting plain strings. It used to be the case that this prop was unexpectedly too liberal, making it look like we supported the complexreact-router-domobject form of the parameter as well, which led to unexpected results at runtime.Patch Changes
a22af3e: Adding aclassNameprop to theMarkdownContentcomponentv0.10.0Compare Source
Minor Changes
32204fa: AddtransformLinkUriandtransformImageUritoMarkdownContentPatch Changes
3c440ea: Change BackstageIconLinkVertical style to use pallette instead of explicit colorc3cfc83: Updated JSDoc to be MDX compatible.b4b711b: Fix the EntityLayout header style so that EntityContextMenu button can display in correct shape when user hover on it944af7f: Work around a bug callingonChangetwice inmuiforRoutedTabso you don't have to press back twice to navigate through tabs7f5e799: Fix relativesub-pathsby concatenating the app's base path with them.a70869e: Updated dependencymswto^0.43.0.693990d: Updated dependency@react-hookz/webto^15.0.0.8006d0f: Updated dependencymswto^0.44.0.15201b1: Updated dependencyrc-progressto3.4.0.7e115d4: Support displaying subtitle text inSidebarSubmenuItemae74694: Improve accessibility for CopyTextButton385389d: Updated to remove usage of theburstsobject in the theme palettebackstage/backstage (@backstage/plugin-api-docs)
v0.11.3Compare Source
Patch Changes
v0.11.2Compare Source
Patch Changes
v0.11.1Compare Source
Patch Changes
c60dc3b: added an optional ESLint rule - no-top-level-material-ui-4-imports - in api-docs plugin which has an auto fix function to migrate the imports and used it to migrate the material-ui imports for plugins/api-docs7854120: Use theAppIconcomponent in the navigation item extension.2be27b9: Updated dependencygraphiqlto3.1.1.efba3d2: Updated dependency@asyncapi/react-componentto1.3.1.v0.11.0Compare Source
Minor Changes
172a717: Migrate theapi-docsto the new frontend system. It is experimental and available via alpha subpath.Patch Changes
874e8cf: Updated README to list AsyncApi v3 as supported9aac2b0: Use--cwdas the firstyarnargument170c023: AddingsupportedSubmitMethodsprop toapi-docsto pass to the Swagger UI. This allows users to specify which HTTP methods they wish to allow end-users to make requests through theTry It Outbutton on the Swagger UI.8fe56a8: Widen@types/reactdependency range to include version 18.c03f977: Updated dependencygraphiqlto3.1.0.49b3b5e: Updated dependency@asyncapi/react-componentto1.2.13.v0.10.3Compare Source
Patch Changes
8a69cc9: Fix custom http resolvers for AsyncAPI widget.062b8f2: Add permission check to Register Existing API button4016f21: Remove some unused dependenciesv0.10.2Compare Source
Patch Changes
816d331: Add dependency ongraphql-configto compensate forgraphql-language-serviceneeding it but not shipping the dep properly615159e: Updated dependencygraphiqlto3.0.10.e16e7ce: Updated dependency@asyncapi/react-componentto1.2.2.82fb18b: Updated dependency@asyncapi/react-componentto1.2.6.53e2c06: Updated dependency@asyncapi/react-componentto1.1.0.v0.10.1Compare Source
v0.10.0Compare Source
Minor Changes
0ac0e10: Replace GraphiQL playground with DocExplorer6231040: Define a default for oauth2RedirectUrl option of swagger-ui-react to match documentationPatch Changes
6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.613a559: Updated dependencygraphiqlto3.0.9.4ad1527: Updated dependency@graphiql/reactto^0.20.0.62b5922: Internal theme type updatesv0.9.12Compare Source
Patch Changes
0117a6b: AddingrequestInterceptoroption toapi-docsand pass it to SwaggerUI. This will enable to configure a proxy or headers to be sent to all the request made through theTry it outbutton on SwaggerUI.9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.18f1756: added aria-label on api definition button for better a11y.v0.9.11Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv0.9.10Compare Source
Patch Changes
v0.9.9Compare Source
v0.9.8Compare Source
v0.9.7Compare Source
Patch Changes
v0.9.6Compare Source
Patch Changes
v0.9.5Compare Source
Patch Changes
865267a: Updated dependency@asyncapi/react-componentto1.0.0-next.48.83bdc3a: Replaced usages oftheme.palette.theme.hintwiththeme.palette.text.secondaryas it has been removed in Material UI v5af748a1: Add support for OpenAPI Specification (OAS) v3.1.0 using swagger-ui v5.0.0.v0.9.4Compare Source
Patch Changes
v0.9.3Compare Source
Patch Changes
v0.9.2Compare Source
Patch Changes
ca50c3b: Corrected styling of nested objects in AsyncAPI to avoid inappropriate uppercase text transformation of nested objects.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.9.1Compare Source
Patch Changes
62b5922: Internal theme type updatesv0.9.0Compare Source
Minor Changes
9ed5321: Adds a new tRPC API definition widget which users can utilize to integrate their tRPC API definitions into Backstage.Patch Changes
60996f8: Updating the readme with bettercspinstructions6856ab9: Updated dependency@asyncapi/react-componentto1.0.0-next.47.v0.8.14Compare Source
Patch Changes
80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.backstage/backstage (@backstage/plugin-auth-backend)
v0.22.3Compare Source
Patch Changes
038b2e6: Only consider entities of kindUserwhen usingfindCatalogUserwith a filter query, unless an explicitkindfilter is provided.v0.22.2Compare Source
Patch Changes
v0.22.1Compare Source
Patch Changes
v0.22.0Compare Source
Minor Changes
293c835: Add support for Service Tokens to Cloudflare Access auth provider492fe83: BREAKING: TheCatalogIdentityClientconstructor now also requires thediscoveryservice to be forwarded from the plugin environment. This is part of the migration to support the new auth services, which has also been done for thecreateRouterfunction.Patch Changes
999224f: Bump dependencyminimatchto v97c29e7f: Fixed refresh scope to match start method in OneLogin provider.2af5354: Bump dependencyjoseto v538af71a: Updated dependencygoogle-auth-libraryto^9.0.0.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.fa7ea3f: Internal refactor to break out how the router is constructedv0.21.3Compare Source
v0.21.2Compare Source
v0.21.1Compare Source
Released a new
@backstage/plugin-config-schemaplugin that is used to show the config schema in a reference documentation format. It's intended for integrators rather than end users, and the idea is to also hook this up to a CLI command that allows browsing of the local schema.v0.21.0Compare Source
Minor Changes
7dd8463: BREAKING: Thesamlprovider has been migrated frompassport-samlto@node-saml/passport-saml.This comes with breaking changes to config options:
audienceis now mandatorywantAuthnResponseSignedis now exposed and defaults totruewantAssertionsSignedis now exposed and defaults totruePatch Changes
97f8724: Support additional algorithms in the/.well-known/openid-configurationendpoint.a3f1fa3: Use the externalizedauth-backend-module-microsoft-provideragain.a9e0107: The auth backend will now refuse to issue user tokens are excessively large.5d2fcba: Migrated oidc auth provider to new@backstage/plugin-auth-backend-module-oidc-providermodule package.d4cc552: The helper functionmakeProfileInfoandPassportHelpers.transformProfilewere refactored to use the
joselibrary.6bb6f3e: Updated dependencyfs-extrato^11.2.0.Updated dependency
@types/fs-extrato^11.0.0.23a98f8: Migrated the AWS ALB auth provider to new@backstage/plugin-auth-backend-module-aws-alb-providermodule package.f5e04e3: Internal refactor to no longer use deprecated types8321c97: AddedexperimentalExtraAllowedOriginsto config8e8a25d: Ability for user to configure backstage token expirationv0.20.3Compare Source
Patch Changes
004499c: Fixed an issue where some Okta's resolvers were missing4016f21: Remove some unused dependenciesv0.20.2Compare Source
v0.20.1Compare Source
Patch Changes
7ac2575:oauth2-proxyauth implementation has been moved to@backstage/plugin-auth-backend-module-oauth2-proxy-provider2a5891e: Migrate the atlassian auth provider to be implemented using the new@backstage/plugin-auth-backend-module-atlassian-providermodule783797a: fix static token issuer not being able to initializee1c189b: The Okta provider implementation is moved to the new modulea62764b: Updated dependencypassportto^0.7.0.bcbbf8e: Updated dependency@google-cloud/firestoreto^7.0.0.v0.20.0Compare Source
Minor Changes
bdf08ad: Adds the StaticTokenIssuer and StaticKeyStore, an alternative token issuer that can be used to sign the Authorization header using a predefined public/private key pair.Patch Changes
243c655: JSDoc and Error message updates to handleAzure Active Directoryre-brand toEntra ID013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.f2fc5ac: Added an optionaladditionalScopesconfiguration parameter tooktaproviders, that lets you add additional scopes on top of the default ones.96c4f54: Reverted the Microsoft auth provider to the previous implementation.v0.19.4Compare Source
v0.19.3Compare Source
Patch Changes
9ff7935: Fixed bug in oidc refresh handler, if token endpoints response on refresh request does not contain a scope, the requested scope is used.2d8f7e8: Migrated the Microsoft auth provider to new@backstage/plugin-auth-backend-module-microsoft-providermodule package.v0.19.2Compare Source
Patch Changes
v0.19.1Compare Source
v0.19.0Compare Source
Minor Changes
71114ac: BREAKING: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
Patch Changes
080cc77: Migrated the GitLab auth provider to be implemented using the new@backstage/plugin-auth-backend-module-gitlab-providermodule.7944d43: AddedauthPluginexport for the new backend system. The plugin does not include any built-in auth providers, they must instead be added by installing additional modules, for exampleauthModuleGoogleProviderfrom@backstage/plugin-auth-backend-module-google-provider.8513cd7: Deprecated several exports that are now available from@backstage/plugin-auth-nodeinstead.7944d43: Added the ability to disable the built-in auth providers by passingdisableDefaultProviderFactoriestocreateRouter.7944d43: The algorithm used when generating Backstage tokens can be configured viaauth.identityTokenAlgorithm.v0.18.8Compare Source
Patch Changes
7944d43: AddedauthPluginexport for the new backend system. The plugin does not include any built-in auth providers, they must instead be added by installing additional modules, for exampleauthModuleGoogleProviderfrom@backstage/plugin-auth-backend-module-google-provider.8513cd7: Deprecated several exports that are now available from@backstage/plugin-auth-nodeinstead.7944d43: Added the ability to disable the built-in auth providers by passingdisableDefaultProviderFactoriestocreateRouter.7944d43: The algorithm used when generating Backstage tokens can be configured viaauth.identityTokenAlgorithm.v0.18.7Compare Source
v0.18.6Compare Source
Patch Changes
16452cd: UpdatedframeHandlerto returnundefinedwhen using the redirect flow instead of returningpostMessageReponsewhich was causing errors9dad4b0: Updated config schema to match what was being used in codebb70a9c: Add frontend visibility to provider objects inauthconfig.v0.18.5Compare Source
Patch Changes
c27ae50: Support for Token Endpoint Auth Method for OIDC Providerv0.18.4Compare Source
Patch Changes
d0f5b0c: Set the expiration time of oidcidTokento be less than backstage session expiration time.v0.18.3Compare Source
Patch Changes
7c116bc: Fixed the way that some request errors are thrown473db60: Fix config schema definition.3ffcdac: Added a persistent session store through the databasev0.18.2Compare Source
Patch Changes
d8f774c: Enforce the secret visibility of certificates and client secrets in the auth backend. Also, document all known options for each auth plugin.7908d72: Introduce a new global config parameter,enableExperimentalRedirectFlow. When enabled, auth will happen with an in-window redirect flow rather than through a popup window.475abd1: Themicrosoft(i.e. Azure) auth provider now supports negotiating tokens forAzure resources besides Microsoft Graph (e.g. AKS, Virtual Machines, Machine
Learning Services, etc.). When the
/frame/handlerendpoint is called with anauthorization code for a non-Microsoft Graph scope, the user profile will not be
fetched. Similarly no user profile or photo data will be fetched by the backend
if the
/refreshendpoint is called with thescopequery parameter strictlycontaining scopes for resources besides Microsoft Graph.
Furthermore, the
offline_accessscope will be requested by default, even whenit is not mentioned in the argument to
getAccessToken. This means that anyAzure access token can be automatically refreshed, even if the user has not
signed in via Azure.
6a90095: Add common identify resolvers foroidcauth provider.a0ef1ec: Export Azure Easy Auth provider so it can actually be used.e0c6e8b: Update peer dependenciesUpdated dependencies
v0.18.1Compare Source
Patch Changes
e262738: Handle difference in expiration time between Microsoft session and Backstage session which caused the Backstage token to be invalid during a time frame.86cece2: Updated dependency@types/passport-microsoftto^1.0.0.52b0022: Updated dependencymswto^1.0.0.529de8c: Added authentication provider for Azure Easy Authentication.v0.18.0Compare Source
Minor Changes
db10b6e: Added a Bitbucket Server Auth Provider and added its API to the app defaultsPatch Changes
v0.17.4Compare Source
v0.17.3Compare Source
Patch Changes
v0.17.2Compare Source
Patch Changes
3280711: Updated dependencymswto^0.49.0.v0.17.1Compare Source
Patch Changes
0d6837c: Fix wrong GitHub callback URL documentationcbe11d1: Tweak README89d705e: Add support for custom JWT header name in GCP IAP auth.abaed97: Improve loggingd80833f: Inject optionalCatalogApiinto auth-backendcreateRouterfunction. This will enable developers to use customizedCatalogApiwhen creating the router.v0.17.0Compare Source
Minor Changes
e2dc42e: Google OAuth refresh tokens will now be revoked on logout by calling Google's API5fa831c: CookieConfigurer can optionally return theSameSitecookie attribute.CookieConfigurer now requires an additional argument
appOrigin- the origin URL of the app - which is used to calculate theSameSiteattribute.defaultCookieConfigurer returns the
SameSiteattribute which defaults toLax. In cases where an auth-backend is running on a different domain than the App,SameSite=Noneis used - but only for secure contexts. This is so that cookies can be included in third-party requests.OAuthAdapterOptions has been modified to require additional arguments,
baseUrl, andcookieConfigurer.OAuthAdapter now resolves cookie configuration using its supplied CookieConfigurer for each request to make sure that the proper attributes always are set.
Patch Changes
b5c1260: Auth0 provider now supports optionalconnectionandconnectionScopeparameters to configure social identity providers.8c6ec17: Fix GitLab provider setup so that it supports GitLab installations with a path in the URL.v0.16.0Compare Source
Minor Changes
2fc41eb: Removed the previously deprecated classAtlassianAuthProvider. Please useproviders.atlassian.create(...)instead.a291688: Renamed theRedirectInfotype toOAuthStartResponse8600855: The auth0 integration is updated to use thepassport-auth0library. The configuration underauth.providers.auth0.\*now supports an optionalaudienceparameter; providing that allows you to connect to the correct API to get permissions, access tokens, and full profile information.What is an Audience
Patch Changes
5b011fb: Allow adding misc claims to JWTd669d89: Minor API signatures cleanup667d917: Updated dependencymswto^0.47.0.87ec2ba: Updated dependencymswto^0.46.0.bf5e903: Updated dependencymswto^0.45.0.e1ebaeb: Cloudflare Access Provider: Add JWT to CloudflareAccessResultv0.15.1Compare Source
Patch Changes
c676a9e: Fixed a bug in auth plugin on the backend where it ignores the skip migration database options when using the database provider.2d7d602: Updated dependency@google-cloud/firestoreto^6.0.0.v0.15.0Compare Source
Minor Changes
9d40407: BREAKING: Removed all directly exported auth provider factories, option types, and sign-in resolvers. For example:AwsAlbProviderOptions,bitbucketUserIdSignInResolver,createGithubProvider. These are all still accessible via theprovidersexport. For example, useproviders.github.create()rather thancreateGithubProvider(), andproviders.bitbucket.resolvers.userIdMatchingUserEntityAnnotation()rather thanbitbucketUserIdSignInResolver.BREAKING: Removed the exported
AuthProviderFactoryOptionstype as well as the deprecated option fields of theAuthProviderFactorycallback. This includes thetokenManager,tokenIssuer,discovery, andcatalogApifields. Existing usage of these should be replaced with the new utilities in theresolverContextfield. The deprecatedTokenIssuertype is now also removed, since it is no longer used.BREAKING: Removed
getEntityClaims, usegetDefaultOwnershipEntityRefsinstead.DEPRECATION: Deprecated
AtlassianAuthProvideras it was unintentionally exported.fe8e025: Allowed post method on /refresh pathPatch Changes
3cedfd8: add Cloudflare Access auth provider to auth-backendf2cf79d: Added an option for the auth backend router to select the algorithm for the JWT token signing keys8e03db9: Auth provider now also export createAuthProviderIntegrationa70869e: Updated dependencymswto^0.43.0.4e9a90e: Updated dependencyluxonto^3.0.0.8006d0f: Updated dependencymswto^0.44.0.679b321: Updated dependencyknexto^2.0.0.859346b: Updated dependencygoogle-auth-libraryto^8.0.0.3a01473: Add new config option for okta auth server and IDPbackstage/backstage (@backstage/plugin-catalog-backend-module-github)
v0.5.7Compare Source
Patch Changes
v0.5.6Compare Source
Patch Changes
v0.5.5Compare Source
Patch Changes
v0.5.4Compare Source
Patch Changes
a936a8f: Migrated theGithubLocationAnalyzerto support new auth services.999224f: Bump dependencyminimatchto v92eb0da3: Support EventsService and events with the new backend system (through EventsService) forGithubOrgEntityProviderandGithubMultiOrgEntityProvider.New/Current Backend System:
The events support for the provider will be enabled always, making it ready to consume events from its subscribed topics.
In order to receive events and make use of this feature, you still need to set up receiving events from the event source as before.
Legacy Backend System:
You can pass the
EventsServiceinstance to the factory method as one of its options:bcf55d5: Support EventsService and events with the new backend system (through EventsService).New/Current Backend System:
The events support for the provider will be enabled always, making it ready to consume events from its subscribed topics.
In order to receive events and make use of this feature, you still need to set up receiving events from the event source as before.
Legacy Backend System:
You can pass the
EventsServiceinstance to the factory method as one of its options:0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.9eab52a: Add location analyzer when installing the moduleUpdated dependencies
v0.5.3Compare Source
Patch Changes
a936a8f: Migrated theGithubLocationAnalyzerto support new auth services.999224f: Bump dependencyminimatchto v90fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.2Compare Source
v0.5.1Compare Source
v0.5.0Compare Source
Minor Changes
a950ed0: Prevent Entity Providers from eliminating Users and Groups from the DB when the synchronisation failsPatch Changes
785ff24: AddedvalidateLocationsExistto the config9477133: Decreased number of teams fetched by GraphQL Query responsible for fetching Teams and Members in organization, due to timeouts when running against big organizations1cae748: Updated dependencygit-url-parseto^14.0.0.v0.4.7Compare Source
Patch Changes
v0.4.6Compare Source
Patch Changes
cc4228e: Switched module ID to use kebab-case.v0.4.5Compare Source
Patch Changes
88b673a: ImportAnalyzeOptionsandScmLocationAnalyzertypes from@backstage/plugin-catalog-nodev0.4.4Compare Source
Patch Changes
890e3b5: Make sure to include the error message when ingestion fails0b55f77: Removed some unused dependencies4f16e60: Request slightly smaller pages of data from GitHubb4b1cbf: MakedefaultUserTransformerresolve toUserEntityinstead ofEntityc101e68: RemovedcatalogModuleGithubOrgEntityProvider. Import from@backstage/plugin-catalog-backend-module-github-orginstead.v0.4.3Compare Source
Patch Changes
b4b1cbf: MakedefaultUserTransformerresolve toUserEntityinstead ofEntityv0.4.2Compare Source
@backstage/create-app@0.3.0
Minor Changes
0101c7a: Add search plugin to default template for CLI created appsPatch Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
@backstage/techdocs-common@0.3.0
Minor Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
@backstage/plugin-techdocs-backend@0.5.0
Minor Changes
a8573e5: techdocs-backend: Simplified file, removing individual preparers and generators.techdocs-backend: UrlReader is now available to use in preparers.
In your Backstage app,
packages/backend/plugins/techdocs.tsfile has now been simplified,to remove registering individual preparers and generators.
Please update the file when upgrading the version of
@backstage/plugin-techdocs-backendpackage.You should be able to remove unnecessary imports, and just do
Patch Changes
a8573e5]@backstage/cli@0.4.3
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json7d72f9b: Fix forapp.listen.hostconfiguration not properly overriding listening host.@backstage/core@0.4.2
Patch Changes
1dc445e: Update to use new plugin extension API342270e: Create AboutCard in core and use it in pagerduty and catalog plugind681db2]1dc445e]@backstage/core-api@0.2.7
Patch Changes
d681db2: Fix for GitHub and SAML auth not properly updating session state when already logged in.1dc445e: Introduce new plugin extension API1dc445e]@backstage/test-utils@0.1.6
Patch Changes
1dc445e: Update to use new plugin extension APId681db2]1dc445e]@backstage/plugin-catalog@0.2.8
Patch Changes
342270e: Create AboutCard in core and use it in pagerduty and catalog plugin19554f6]1dc445e]342270e]@backstage/plugin-catalog-backend@0.5.1
Patch Changes
5de26b9: Start warning about usage of deprecated location types, such asgithub30d6c78: Added configuration schema for the commonly used properties5084e50: Updated the config schema@backstage/plugin-github-actions@0.2.6
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.jsond681db2]1dc445e]342270e]1dc445e]@backstage/plugin-graphiql@0.2.3
Patch Changes
1dc445e: Update to use new plugin extension API1dc445e]342270e]@backstage/plugin-pagerduty@0.2.4
Patch Changes
342270e: Create AboutCard in core and use it in pagerduty and catalog plugin1dc445e]342270e]@backstage/plugin-scaffolder@0.3.5
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json1dc445e]342270e]@backstage/plugin-scaffolder-backend@0.3.6
Patch Changes
19554f6: Added Github Actions for Create React App, and allow better imports of files inside a module when they're exposed usingfilesinpackage.json33a82a7: GitLab preparer uses the right token (primarily the same one as the publisher, falling back to the integrations token)aed8f7f: Clearer error message when preparer or publisher type can't be determined.@backstage/plugin-techdocs@0.5.1
Patch Changes
d681db2]1dc445e]342270e]1dc445e]a8573e5]example-app@0.2.8
Patch Changes
19554f6]1dc445e]342270e]7d72f9b]example-backend@0.2.8
Patch Changes
7cfcd58: use node 14 for backend Dockerfile19554f6]33a82a7]5de26b9]30d6c78]5084e50]a8573e5]aed8f7f]v0.4.1Compare Source
@backstage/catalog-model@0.6.0
Minor Changes
ac3560b: RemoveimplementsApisfromComponententities. Deprecation happened in #3449.Use
providesApisinstead.Patch Changes
c911061: Introduce aprofilesection for group entities that can optional include adisplayName,emailandpicture.0e6298f: Ignore relations when comparing entities. This stops the refresh loop from rewriting entities over and over.@backstage/techdocs-common@0.2.0
Minor Changes
dae4f39: Breaking changesAdded option to use Google Cloud Storage as a choice to store the static generated files for TechDocs.
It can be configured using
techdocs.publisher.typeoption inapp-config.yaml.Step-by-step guide to configure GCS is available here https://backstage.io/docs/features/techdocs/using-cloud-storage
Set
techdocs.publisher.typeto'local'if you want to continue using local filesystem to store TechDocs files.techdocs.builderis now required and can be set to'local'or'external'. (Set it to'local'for now, since CI/CD buildworkflow for TechDocs will be available soon (in few weeks)).
If builder is set to 'local' and you open a TechDocs page,
techdocs-backendwill try to generate the docs, publish to storage andshow the generated docs afterwords.
If builder is set to
'external',techdocs-backendwill only fetch the docs and will NOT try to generate and publish. In this case of'external',we assume that docs are being built in the CI/CD pipeline of the repository.
TechDocs will not assume a default value for
techdocs.builder. It is better to explicitly define it in theapp-config.yaml.When configuring TechDocs in your backend, there is a difference in how a new publisher is created.
--- const publisher = new LocalPublish(logger, discovery);
+++ const publisher = Publisher.fromConfig(config, logger, discovery);
Based on the config
techdocs.publisher.type, the publisher could be either Local publisher or Google Cloud Storage publisher.techdocs.storageUrlis now a required config. Should behttp://localhost:7000/api/techdocs/static/docsin most setups.Parts of
@backstage/plugin-techdocs-backendhave been moved to a new package@backstage/techdocs-commonto generate docs. Also to publish docsto-and-fro between TechDocs and a storage (either local or external). However, a Backstage app does NOT need to import the
techdocs-commonpackage -app should only import
@backstage/plugin-techdocsand@backstage/plugin-techdocs-backend.Patch changes
See all of TechDocs config options and its documentation https://backstage.io/docs/features/techdocs/configuration
Logic about serving static files and metadata retrieval have been abstracted away from the router in
techdocs-backendto the instance of publisher.Removed Material UI Spinner from TechDocs header. Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook).
Patch Changes
c911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-catalog-backend@0.5.0
Minor Changes
6b37c95: Write relations directly as part of batch add / update of entities.Slight change of the
CommonDatabasecontract:addEntityremovedDbEntityRequesthas a new fieldrelationsac3560b: RemoveimplementsApisfromComponententities. Deprecation happened in #3449.Use
providesApisinstead.Patch Changes
c6eeefa: Add support for Github Enterprise in GitHubOrgReaderProcessor so you can properly ingest users of a GHE organization.fb386b7: Break the refresh loop into several smaller transactions7c3ffc0: Supportprofileof groups includingdisplayName,email, andpictureinLdapOrgReaderProcessor. The source fields for them can be configured in theldapOrgprovider.e7496dc: Break out GithubOrgReaderProcessor config into its own file for consistency with the other org processors.8dd0a90: Supportprofileof groups includingdisplayNameandpictureinGithubOrgReaderProcessor. Fixes the import ofdescriptionfor groups.8c31c68: Batch the writing of statuses after refreshes. This reduced the runtime on sqlite from 16s to 0.2s, and on pg from 60s to 1s on my machine, for the huge LDAP set.7b98e7f: Add index to foreign key columns. Postgres (and others) do not do this on the "source" side of a foreign key relation, which was what led to the slowness on large datasets. The full LDAP dataset ingestion now takes two minutes, which is not optimal yet but still a huge improvement over before when it basically never finished :)0097057: Supportprofileof groups includingdisplayNameandemailinMicrosoftGraphOrgReaderProcessor. Importingpicturedoesn't work yet, asthe Microsoft Graph API does not expose them correctly.
c911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-techdocs@0.5.0
Minor Changes
dae4f39: Breaking changesAdded option to use Google Cloud Storage as a choice to store the static generated files for TechDocs.
It can be configured using
techdocs.publisher.typeoption inapp-config.yaml.Step-by-step guide to configure GCS is available here https://backstage.io/docs/features/techdocs/using-cloud-storage
Set
techdocs.publisher.typeto'local'if you want to continue using local filesystem to store TechDocs files.techdocs.builderis now required and can be set to'local'or'external'. (Set it to'local'for now, since CI/CD buildworkflow for TechDocs will be available soon (in few weeks)).
If builder is set to 'local' and you open a TechDocs page,
techdocs-backendwill try to generate the docs, publish to storage andshow the generated docs afterwords.
If builder is set to
'external',techdocs-backendwill only fetch the docs and will NOT try to generate and publish. In this case of'external',we assume that docs are being built in the CI/CD pipeline of the repository.
TechDocs will not assume a default value for
techdocs.builder. It is better to explicitly define it in theapp-config.yaml.When configuring TechDocs in your backend, there is a difference in how a new publisher is created.
--- const publisher = new LocalPublish(logger, discovery);
+++ const publisher = Publisher.fromConfig(config, logger, discovery);
Based on the config
techdocs.publisher.type, the publisher could be either Local publisher or Google Cloud Storage publisher.techdocs.storageUrlis now a required config. Should behttp://localhost:7000/api/techdocs/static/docsin most setups.Parts of
@backstage/plugin-techdocs-backendhave been moved to a new package@backstage/techdocs-commonto generate docs. Also to publish docsto-and-fro between TechDocs and a storage (either local or external). However, a Backstage app does NOT need to import the
techdocs-commonpackage -app should only import
@backstage/plugin-techdocsand@backstage/plugin-techdocs-backend.Patch changes
See all of TechDocs config options and its documentation https://backstage.io/docs/features/techdocs/configuration
Logic about serving static files and metadata retrieval have been abstracted away from the router in
techdocs-backendto the instance of publisher.Removed Material UI Spinner from TechDocs header. Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook).
Patch Changes
c911061]dae4f39]8ef71ed]0e6298f]7dd2ef7]ac3560b]@backstage/plugin-techdocs-backend@0.4.0
Minor Changes
dae4f39: Breaking changesAdded option to use Google Cloud Storage as a choice to store the static generated files for TechDocs.
It can be configured using
techdocs.publisher.typeoption inapp-config.yaml.Step-by-step guide to configure GCS is available here https://backstage.io/docs/features/techdocs/using-cloud-storage
Set
techdocs.publisher.typeto'local'if you want to continue using local filesystem to store TechDocs files.techdocs.builderis now required and can be set to'local'or'external'. (Set it to'local'for now, since CI/CD buildworkflow for TechDocs will be available soon (in few weeks)).
If builder is set to 'local' and you open a TechDocs page,
techdocs-backendwill try to generate the docs, publish to storage andshow the generated docs afterwords.
If builder is set to
'external',techdocs-backendwill only fetch the docs and will NOT try to generate and publish. In this case of'external',we assume that docs are being built in the CI/CD pipeline of the repository.
TechDocs will not assume a default value for
techdocs.builder. It is better to explicitly define it in theapp-config.yaml.When configuring TechDocs in your backend, there is a difference in how a new publisher is created.
--- const publisher = new LocalPublish(logger, discovery);
+++ const publisher = Publisher.fromConfig(config, logger, discovery);
Based on the config
techdocs.publisher.type, the publisher could be either Local publisher or Google Cloud Storage publisher.techdocs.storageUrlis now a required config. Should behttp://localhost:7000/api/techdocs/static/docsin most setups.Parts of
@backstage/plugin-techdocs-backendhave been moved to a new package@backstage/techdocs-commonto generate docs. Also to publish docsto-and-fro between TechDocs and a storage (either local or external). However, a Backstage app does NOT need to import the
techdocs-commonpackage -app should only import
@backstage/plugin-techdocsand@backstage/plugin-techdocs-backend.Patch changes
See all of TechDocs config options and its documentation https://backstage.io/docs/features/techdocs/configuration
Logic about serving static files and metadata retrieval have been abstracted away from the router in
techdocs-backendto the instance of publisher.Removed Material UI Spinner from TechDocs header. Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook).
Patch Changes
c911061]dae4f39]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/backend-common@0.4.1
Patch Changes
1d1c286: Implement readTree on BitBucketUrlReader and getBitbucketDownloadUrl4eafdec: Introduce readTree method for GitLab URL Reader1d1c286]4eafdec]178e093]@backstage/catalog-client@0.3.4
Patch Changes
c911061]0e6298f]ac3560b]@backstage/cli@0.4.2
Patch Changes
c36a01b: Re-enable symlink resolution during bundling, and switch to using a resolve plugin for external linked packages.@backstage/core@0.4.1
Patch Changes
8ef71ed: Add a<Avatar>component to@backstage/core.7dd2ef7]@backstage/core-api@0.2.6
Patch Changes
7dd2ef7: Use auth provider ID to create unique session storage keys for GitHub and SAML Auth.@backstage/create-app@0.2.5
Patch Changes
2783ec0: In the techdocs-backend plugin (packages/backend/src/plugins/techdocs.ts), create a publisher usinginstead of
An instance of
publishercan either be a local filesystem publisher or a Google Cloud Storage publisher.Read more about the configs here https://backstage.io/docs/features/techdocs/configuration
(You will also have to update
techdocs.storage.typetolocalorgoogleGcs. Andtechdocs.builderto eitherlocalorexternal.)@backstage/integration@0.1.4
Patch Changes
1d1c286: Implement readTree on BitBucketUrlReader and getBitbucketDownloadUrl4eafdec: Introduce readTree method for GitLab URL Reader178e093: Validate that integration config contains a valid host@backstage/plugin-api-docs@0.4.1
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-auth-backend@0.2.7
Patch Changes
7b15cc2: Added configuration schema for the commonly used propertiesc911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-catalog@0.2.7
Patch Changes
c911061]dae4f39]8ef71ed]0e6298f]ac3560b]@backstage/plugin-catalog-graphql@0.2.5
Patch Changes
c911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-catalog-import@0.3.2
Patch Changes
f3e7550: Add description to Pull Request when registering a new componentc6eeefa]fb386b7]c911061]7c3ffc0]e7496dc]8ef71ed]1d1c286]0e6298f]8dd0a90]4eafdec]6b37c95]8c31c68]7b98e7f]178e093]ac3560b]0097057]@backstage/plugin-circleci@0.2.5
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-cloudbuild@0.2.5
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-cost-insights@0.5.2
Patch Changes
48c305e: pin all projects selection to the top of menu list8ef71ed]@backstage/plugin-github-actions@0.2.5
Patch Changes
c911061]8ef71ed]0e6298f]7dd2ef7]ac3560b]@backstage/plugin-jenkins@0.3.4
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-kubernetes@0.3.3
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-kubernetes-backend@0.2.3
Patch Changes
c911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-lighthouse@0.2.6
Patch Changes
c911061]8ef71ed]0e6298f]7dd2ef7]ac3560b]@backstage/plugin-org@0.3.2
Patch Changes
c0fac61: Wrap entity cards on smaller screensab80586: Ensure a name is always displayed for user entities in the org plugin. This can happen when there is no profiledisplayName provided (e.g. a GitHub user that has not added a name to their profile)
8ef71ed: Add a<Avatar>component to@backstage/core.c5297ba: Display the newprofilefields (displayName,email, andpicture) forgroups on the
GroupProfileCard.This also resolves some cases where
profilefields are missing for users orgroups and for example falls back to displaying the entity name. Adds additional test data to the ACME Corp dataset.
Updated dependencies [
c911061]Updated dependencies [
8ef71ed]Updated dependencies [
0e6298f]Updated dependencies [
ac3560b]@backstage/plugin-pagerduty@0.2.3
Patch Changes
3b50f83: Supporting Timezonesc911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-register-component@0.2.5
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-rollbar@0.2.7
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-scaffolder@0.3.4
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-scaffolder-backend@0.3.5
Patch Changes
94c65a9: Added configuration schema for the commonly used propertiesc911061]1d1c286]0e6298f]4eafdec]ac3560b]@backstage/plugin-search@0.2.4
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-sentry@0.3.1
Patch Changes
962d1ad: Added configuration schema for the commonly used propertiesc911061]8ef71ed]0e6298f]ac3560b]@backstage/plugin-sonarqube@0.1.7
Patch Changes
c911061]8ef71ed]0e6298f]ac3560b]example-app@0.2.7
Patch Changes
c0fac61]48c305e]c911061]ab80586]dae4f39]8ef71ed]0e6298f]f3e7550]3b50f83]c36a01b]c5297ba]ac3560b]962d1ad]example-backend@0.2.7
Patch Changes
c6eeefa]fb386b7]c911061]7c3ffc0]dae4f39]7b15cc2]e7496dc]1d1c286]0e6298f]8dd0a90]4eafdec]6b37c95]8c31c68]7b98e7f]ac3560b]94c65a9]0097057]v0.4.0Compare Source
Minor Changes
fa7004d: Added acatalogModuleGithubOrgEntityProviderfor the new backend systemPatch Changes
71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
3d63e60: Internal restructure to avoid circular imports96353bb: Properly support customuserTransformerreturningundefinedinGithubMultiOrgEntityProvider3c44761: Allow github user and team transforms to return any EntityUpdated dependencies
v0.3.7Compare Source
v0.3.6Compare Source
v0.3.5Compare Source
Patch Changes
v0.3.4Compare Source
v0.3.3Compare Source
Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config4b82382: Fixed invalid configuration schema. The configuration schema may be more strict as a result.81c231c: Fixed a bug where the visibility filter was case sensitive and casting was inconsistent.v0.3.2Compare Source
Patch Changes
b01b869: fixed event handler to respect configured organization68531cc: Break some internal circular import chainsv0.3.1Compare Source
Patch Changes
b9a6d13: Properly handleasyncevent callbackdf84117: Add support for Repository Variables and Secrets to thepublish:githubandgithub:repo:createscaffolder actions. You will need to addread/writepermissions to your GITHUB_TOKEN and/or Github Backstage App for RepositorySecretsandVariablesUpgrade octokit introduces some breaking changes.
Updated dependencies
v0.3.0Compare Source
Minor Changes
970678a: Implement events support forGithubMultiOrgEntityProviderBREAKING: Passing in a custom
teamTransformerwill now correctly completely override the default transformer behaviorPatch Changes
78bb674: Fixed bug in queryWithPaging that caused secondary rate limit errors in GitHub with organizations having more than 1000 repositories. This change makes one request per second to avoid concurrency issues.bd101ce: Updated theteam.editedevent emitted fromGithubOrgEntityProviderto also include teams description.v0.2.7Compare Source
Patch Changes
3756dd9:GitHubEntityProvider: Add option to configure visibility filter viaapp-config.yaml.Please find how to configure visibility filter config at https://backstage.io/docs/integrations/github/discovery
3160138: ImplementGithubMultiOrgEntityProviderfor sourcing group and user entities from multiple GitHub organizationsUpdated dependencies
v0.2.6Compare Source
Patch Changes
6545487: Minor API report tweaks90469c0: RenamedgithubEntityProviderCatalogModuletocatalogModuleGithubEntityProviderto match the recommended naming patterns.e675f90: Make sure to not use deprecated exports from@backstage/plugin-catalog-backend928a12a: Internal refactor of/alphaexports.52b0022: Updated dependencymswto^1.0.0.v0.2.5Compare Source
Patch Changes
6615875: Add support for filtering out forks80afd5f: Use github team slug and login annotations rather than entity name to infer location annotations85b04f6: Internal refactor to not use deprecatedsubstrv0.2.4Compare Source
v0.2.3Compare Source
Patch Changes
427d8f4: Added support for event based updates in theGithubOrgEntityProvider!Based on webhook events from GitHub the affected
UserorGroupentity will be refreshed.This includes adding new entities, refreshing existing ones, and removing obsolete ones.
Please find more information at
https://backstage.io/docs/integrations/github/org#installation-with-events-support
f8d91a8: fixedcatalogPathoption to properly glob match on received GitHub events.9f2b786: Provide context for logged errors.8e06f3c: Switched imports ofloggerToWinstonLoggerto@backstage/backend-common.Updated dependencies
backstage/backstage (@backstage/plugin-catalog-graph)
v0.4.3Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.4.2Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.4.1Compare Source
Patch Changes
d4ff0bb: Added theno-top-level-material-ui-4-importsESLint rule to aid with the migration to Material UI v5v0.4.0Compare Source
Minor Changes
3dc64e9: Migrate plugin to the new frontend system, it is experimental and available via alpha subpath.Patch Changes
916da47: Change default icon for unknown entities to nothing instead of the help icon.f937aae: useCatalogClient.getEntitiesByRefs()to reduce the number of backend requests from plugincatalog-graph3e1c6e2: Added possibility to show arrow heads for graph edges for better understandability.In order to show arrow heads in the catalog graph page, add
showArrowHeadsattribute toCatalogGraphPagecomponent(typically in
packages/app/src/App.tsx):In order to show arrow heads in entity graphs, add
showArrowHeadsattribute toEntityCatalogGraphCardcomponents(typically multiple occurrences in
packages/app/src/components/catalog/EntityPage.tsx):9aac2b0: Use--cwdas the firstyarnargument8fe56a8: Widen@types/reactdependency range to include version 18.Updated dependencies
v0.3.3Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.3.2Compare Source
Patch Changes
v0.3.1Compare Source
@backstage/backend-common@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:8e2effb: Refactored UrlReader.readTree to be required and accept (url, options)Patch Changes
1722cb5: Added configuration schema7b37e68: Added the integration package1722cb5]7b37e68]@backstage/catalog-client@0.3.0
Minor Changes
717e43d: Changed the getEntities interface to (1) nest parameters in an object, (2) support field selection, and (3) return an object with an items field for future extension@backstage/cli@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:Patch Changes
1722cb5: Added configuration schema9023404: Support specifying listen host/port for frontend1722cb5]@backstage/config-loader@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:@backstage/plugin-app-backend@0.3.0
Minor Changes
1722cb5: Use new config schema support to automatically inject config with frontend visibility, in addition to the existing env schema injection.This removes the confusing behavior where configuration was only injected into the app at build time. Any runtime configuration (except for environment config) in the backend used to only apply to the backend itself, and not be injected into the frontend.
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-cost-insights@0.4.0
Minor Changes
4040d4f: remove cost insights currency feature flagPatch Changes
1722cb5: Added configuration schema17a9f48: remove excessive margin from cost overview bannerf360395: UI improvements: Increase width of first column in product entity dialog tableUI improvement: Display full cost amount in product entity dialog table
259d848: Fix savings/excess display calculation1722cb5]@backstage/core@0.3.1
Patch Changes
1722cb5: Added configuration schema@backstage/create-app@0.2.2
Patch Changes
7d7abd5: Addapp-backendas a backend plugin, and make a single docker build of the backend the default way to deploy backstage.Note that the
app-backendcurrently only is a solution for deployments of the app, it's not a dev server and is not intended for local development.Template changes
Installing the
app-backendplugin in the backendDocker build setup
Should be the same as backend.baseUrl when using the
app-backendplugin@backstage/dev-utils@0.1.4
Patch Changes
1722cb5]1722cb5]9023404]@backstage/integration@0.1.1
Patch Changes
7b37e68: Added the integration package@backstage/test-utils@0.1.3
Patch Changes
1722cb5]1722cb5]9023404]@backstage/plugin-auth-backend@0.2.2
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]717e43d]@backstage/plugin-catalog@0.2.2
Patch Changes
8b7737d: Add About Card tooltips1722cb5]717e43d]@backstage/plugin-catalog-backend@0.2.1
Patch Changes
f531d30: An entity A, that exists in the catalog, can no longer be overwritten by registering a different location that also tries to supply an entity with the same kind+namespace+name. Writes of that new entity will instead be rejected with a log message similar toRejecting write of entity Component:default/artist-lookup from file:/Users/freben/dev/github/backstage/packages/catalog-model/examples/components/artist-lookup-component.yaml because entity existed from github:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-catalog-graphql@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-graphql-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-kubernetes-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-lighthouse@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-proxy-backend@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-rollbar@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-rollbar-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-scaffolder-backend@0.3.1
Patch Changes
d33f515: Extracted pushToRemote function for reuse between publishers1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-sentry@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]@backstage/plugin-sentry-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-techdocs@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-techdocs-backend@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-user-settings@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]example-app@0.2.2
Patch Changes
3efd03c: Removed obsolete CircleCI proxy config from example-app1722cb5]1722cb5]17a9f48]4040d4f]f360395]259d848]8b7737d]9023404]example-backend@0.2.2
Patch Changes
1722cb5]1722cb5]1722cb5]f531d30]3efd03c]7b37e68]8e2effb]d33f515]v0.3.0Compare Source
Minor Changes
a604623: Add the entireEntitytoEntityNodeDataand deprecatename,kind,title,namespaceandspec.To get the deprecated properties in your custom component you can use:
Patch Changes
6c2b872: Add official support for React 18.62b5922: Internal theme type updatesv0.2.37Compare Source
Patch Changes
9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v0.2.36Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.2.35Compare Source
Patch Changes
v0.2.34Compare Source
v0.2.33Compare Source
Patch Changes
64ee2c0: Propagate entity spec to EntityNode so that spec info such as type can be used for graph node customization62dc7a2: Added maximum depth parameter to the catalogGraphParams in CatalogGraphCard.12a8c94: Add package repository and homepage metadatav0.2.32Compare Source
Patch Changes
v0.2.31Compare Source
Patch Changes
v0.2.30Compare Source
Patch Changes
d446f8f: Expose allEntityRelationsGraphPropsto Catalog Graph Pagev0.2.29Compare Source
Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.2.28Compare Source
Patch Changes
v0.2.27Compare Source
Patch Changes
c51efce: Update docs to always useyarn add --cwdfor app & backendfe19058: Fix #16245: The CatalogGraphCard has parameter naming errors for CatalogGraphPage1827710: Expose additional props on theCatalogGraphCardto allow for custom node & label rendering or kind/relation filtering.v0.2.26Compare Source
Patch Changes
99f05cb: The link from theCatalogGraphCardto theCatalogGraphPageno longer includes an explicitmaxDepthparameter, letting theCatalogGraphPagechoose the initialmaxDepthinstead.backstage/backstage (@backstage/plugin-catalog-import)
v0.10.9Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.10.8Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.10.7Compare Source
Patch Changes
b91a8d2: Added theno-top-level-material-ui-4-importsESLint rule to aid with the migration to Material UI v575f686b: Fixed an issue generating a wrong entity link at the end of the import processadc0414: fix related to component name not adhering to kubernetes valid object name.v0.10.6Compare Source
Patch Changes
916da47: Change default icon for unknown entities to nothing instead of the help icon.9aac2b0: Use--cwdas the firstyarnargument8fe56a8: Widen@types/reactdependency range to include version 18.1cae748: Updated dependencygit-url-parseto^14.0.0.v0.10.5Compare Source
Patch Changes
v0.10.4Compare Source
Patch Changes
03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.5814122: Updated/alphaexports to fit new naming patterns.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.v0.10.3Compare Source
v0.10.2Compare Source
Patch Changes
6db75b9: Create an experimental plugin that is compatible with the declarative integration system, it is exported from the/alphasubpath.6c2b872: Add official support for React 18.dee1f39: Fix missing children key warning on the default catalog import page.71c97e7: Theapp.titleconfiguration is now properly required to be a string.v0.10.1Compare Source
Patch Changes
v0.10.0Compare Source
Minor Changes
c3c1fd3: Slight change to thePreparePullRequestFormProps, because of an update toreact-hook-form.Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.9.13Compare Source
Patch Changes
v0.9.12Compare Source
v0.9.11Compare Source
Patch Changes
v0.9.10Compare Source
Patch Changes
36b7edf: Add a "View Component" button as the primary CTA after registering a new component using a link to catalog-info.yamlv0.9.9Compare Source
Patch Changes
2ef84c0: Added analytics event for import entity button309d297: SwapImportStepperandInfoCardorder to fix tab order incatalog-import.v0.9.8Compare Source
Patch Changes
v0.9.7Compare Source
Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.9.6Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.v0.9.5Compare Source
Patch Changes
v0.9.4Compare Source
Patch Changes
v0.9.3Compare Source
Patch Changes
v0.9.2Compare Source
Patch Changes
2e701b3: Internal refactor to usereact-router-domrather thanreact-router.3280711: Updated dependencymswto^0.49.0.v0.9.1Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.9.0Compare Source
Minor Changes
b2e6cb6: BreakingMoved the code search for the existing catalog-info.yaml files to the backend from the frontend. It means it will use the configured GitHub integration's credentials.
Add the following to your
CatalogBuilderto have the repo URL ingestion working again.Patch Changes
backstage/backstage (@backstage/plugin-github-actions)
v0.6.14Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.6.13Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.6.12Compare Source
Patch Changes
8ab3218: Fixed bug in WorkflowRunStatus component where skipped and cancelled workflow runs appeared as success692316d: Fixed bug in WorkflowRunStatus component where status description of skipped and cancelled workflow runs appeared as successv0.6.11Compare Source
Patch Changes
9aac2b0: Use--cwdas the firstyarnargument8fe56a8: Widen@types/reactdependency range to include version 18.1cae748: Updated dependencygit-url-parseto^14.0.0.v0.6.10Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.6.9Compare Source
Patch Changes
08d7e46: Github Workflow Runs UI is modified to show in optional Card view instead of table, with branch selection optionv0.6.8Compare Source
v0.6.7Compare Source
Patch Changes
6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.fdb5e23: ImportMissingAnnotationEmptyStatefrom@backstage/plugin-catalog-reactto remove the cyclical dependencyee0c44c: Fixed an issue that was preventing the sorting of workflow runs by their status.v0.6.6Compare Source
Patch Changes
9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v0.6.5Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependency406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv0.6.4Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependencyv0.6.3Compare Source
v0.6.2Compare Source
Patch Changes
v0.6.1Compare Source
Patch Changes
v0.6.0Compare Source
Minor Changes
96e1004: Added support GitHub Enterprise hosted repositories.BREAKING: The
GithubActionsClientis updated to take anscmAuthApiinstead of the previousgithubAuthApi. This does not require any code changes unless you construct your ownGithubActionsClientPatch Changes
v0.5.18Compare Source
Patch Changes
v0.5.17Compare Source
Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.5.16Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.v0.5.15Compare Source
Patch Changes
v0.5.14Compare Source
Patch Changes
27a5e90: Small updates to some paragraph components to ensure theme typography properties are inherited correctly.backstage/backstage (@backstage/plugin-org)
v0.6.23Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use library0df5c60: Added ESLint ruleno-top-level-material-ui-4-importsin theorgplugin to migrate the Material UI imports.v0.6.22Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use library0df5c60: Added ESLint ruleno-top-level-material-ui-4-importsin theorgplugin to migrate the Material UI imports.v0.6.21Compare Source
Patch Changes
b7b0466: Remove the use of the deprecatedcustomStylesforAvatar526f00a: Document the new frontend system extensions for the org plugin.2219f8c: AddrelationsTypeargument toMembersListCard.This can be used to display an aggregated user list for groups by default.
a767aaa: Fixed an issue where theOwnershipCardcomponent failed to scroll properly when used alongsidereact-grid-layout.v0.6.20Compare Source
Patch Changes
8fe56a8: Widen@types/reactdependency range to include version 18.6e1bf50: Added basic support for the new frontend system, exported from the/alphasubpath.v0.6.19Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.6.18Compare Source
Patch Changes
59c24b9: Fix issue where members inside of<EntityMembersListCard>would be rendered as squished when the card itself was shrunk down.3a65d9c: Support member list scrollable when parent has specified height4785d05: Add permission check to catalog create and refresh buttonv0.6.17Compare Source
v0.6.16Compare Source
Patch Changes
6c2b872: Add official support for React 18.62b5922: Internal theme type updatesv0.6.15Compare Source
Patch Changes
dc5b6b9: Fixed the display of OwnershipCard with aggregated relations by loading relations when getting children of entity.This allows the already existing recursive method to work properly when children of entity have children themselves.
9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v0.6.14Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependency406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.43a2137: Ensure direct relations are shown for User entities while keeping support for aggregating closest parent group ownershipdd9329c: Entity relations toggle should by default be aggregated for User entities8cec766: Removed@types/nodedependencyv0.6.13Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependencyv0.6.12Compare Source
v0.6.11Compare Source
Patch Changes
5033120: Fixed bug in MembersListCard component where the url for the members was static which was breaking the component when catalog route was changed12a8c94: Add package repository and homepage metadatav0.6.10Compare Source
Patch Changes
v0.6.9Compare Source
Patch Changes
0151ed6: EntityOwnershipCard: Fix color to pick up from page theme for component type2e03636: UpdatedalertApiusages with severity ofinfoorsuccessto usedisplay: transientv0.6.8Compare Source
Patch Changes
6e387c0: Changed the MembersListCard component to allow displaying aggregated members when viewing a group. Now, a toggle switch can be displayed that lets you switch between showing direct members and aggregated members.To enable this new feature, set the showAggregateMembersToggle prop on EntityMembersListCard:
Updated dependencies
v0.6.7Compare Source
Patch Changes
d7c8d8c: Allow the title of the group profile card to use the title of the entity, if it is set.8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)228ab67: AddedentityLimitto change the limit of entities displayed in the ownership boxes.StoryBook Example for Ownership Card
e0c6e8b: Update peer dependenciesUpdated dependencies
v0.6.6Compare Source
Patch Changes
cb8ec97: Change black & white colors to be theme aware36bccb5: Fix small UI-glitch in MemberListCard52b0022: Updated dependencymswto^1.0.0.a06fcac: Add styling to theMembersListCardandComponentsGridto handle overflow text.v0.6.5Compare Source
Patch Changes
5a4fa88: UpdatedLinksGroupto useLinkoverListItemas this makes the links more obvious and follows the pattern already used in theGroupProfileCard. Also updated theGroupProfileCardExtraDetailsstory in Storybook to enable theshowLinksfeature with this off there is no difference between it and thedefaultstory.v0.6.4Compare Source
Patch Changes
v0.6.3Compare Source
Patch Changes
v0.6.2Compare Source
Patch Changes
v0.6.1Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.6.0Compare Source
Minor Changes
0b11500: Updates the User and Group Profile cards to add the links from the UserEntity or the GroupEntityPatch Changes
38dd29e: Add entity kind to the Ownership Cards. Fix the query parameters for the links of the Ownership Cards so that the catalog page actually selects the right entity kind.backstage/backstage (@backstage/plugin-permission-common)
v0.7.13Compare Source
Patch Changes
0502d82: Thetokenoption of thePermissionEvaluatormethods is now deprecated. The options that only apply to backend implementations have been moved toPermissionsServicefrom@backstage/backend-plugin-apiinstead.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.7.12Compare Source
Patch Changes
b1acd9b: Updated READMEv0.7.11Compare Source
Patch Changes
0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.7.10Compare Source
Patch Changes
4aa43f6: Updated dependencycross-fetchto^4.0.0.v0.7.9Compare Source
Patch Changes
v0.7.8Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.7.7Compare Source
Patch Changes
v0.7.6Compare Source
Patch Changes
v0.7.5Compare Source
Patch Changes
1e4f5e9: Bumpzodandzod-to-json-schemadependencies.v0.7.4Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.v0.7.3Compare Source
Patch Changes
v0.7.2Compare Source
Patch Changes
b05dcd5: Move thezoddependency to a version that does not collide with other libraries3280711: Updated dependencymswto^0.49.0.v0.7.1Compare Source
Patch Changes
0502d82: Thetokenoption of thePermissionEvaluatormethods is now deprecated. The options that only apply to backend implementations have been moved toPermissionsServicefrom@backstage/backend-plugin-apiinstead.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.7.0Compare Source
Minor Changes
46b4a72: BREAKING: When defining permission rules, it's now necessary to provide a ZodSchema that specifies the parameters the rule expects. This has been added to help better describe the parameters in the response of the metadata endpoint and to validate the parameters before a rule is executed.To help with this, we have also made a change to the API of permission rules. Before, the permission rules
toQueryandapplysignature expected parameters to be separate arguments, like so...The API has now changed to expect the parameters as a single object
One final change made is to limit the possible values for a parameter to primitives and arrays of primitives.
Patch Changes
backstage/backstage (@backstage/plugin-permission-node)
v0.7.27Compare Source
Patch Changes
v0.7.26Compare Source
Patch Changes
v0.7.25Compare Source
Patch Changes
0502d82: TheServerPermissionClienthas been migrated to implement thePermissionsServiceinterface, now accepting the newBackstageCredentialsobject in addition to thetokenoption, which is now deprecated. It now also optionally depends on the newAuthService.v0.7.24Compare Source
Patch Changes
0502d82: TheServerPermissionClienthas been migrated to implement thePermissionsServiceinterface, now accepting the newBackstageCredentialsobject in addition to thetokenoption, which is now deprecated. It now also optionally depends on the newAuthService.v0.7.23Compare Source
v0.7.22Compare Source
v0.7.21Compare Source
Patch Changes
v0.7.20Compare Source
Patch Changes
b1acd9b: Updated READMEv0.7.19Compare Source
Patch Changes
0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.7.18Compare Source
Patch Changes
v0.7.17Compare Source
Patch Changes
v0.7.16Compare Source
Patch Changes
v0.7.15Compare Source
v0.7.14Compare Source
Patch Changes
a8a614b: Minorpackage.jsonupdate.v0.7.13Compare Source
Patch Changes
v0.7.12Compare Source
v0.7.11Compare Source
Patch Changes
v0.7.10Compare Source
Patch Changes
v0.7.9Compare Source
Patch Changes
v0.7.8Compare Source
Patch Changes
a788e71:createPermissionIntegrationRouternow accepts rules and permissions for multiple resource types. Example:Updated dependencies
v0.7.7Compare Source
Patch Changes
788f0f5: Introduced alpha export of thepolicyExtensionPointfor use in the new backend system.71fd096: Added createConditionAuthorizer utility function, which takes some permission conditions and returns a function that returns a definitive authorization result given a decision and a resource.1e4f5e9: Bumpzodandzod-to-json-schemadependencies.v0.7.6Compare Source
Patch Changes
27a103c: Changed thecreatePermissionIntegrationRouterAPI to allowgetResources,resourceTypeandrulesto be optional37e9215: Update the service-to-service auth docs URL in error message.``
52b0022: Updated dependencymswto^1.0.0.v0.7.5Compare Source
Patch Changes
v0.7.4Compare Source
v0.7.3Compare Source
Patch Changes
v0.7.2Compare Source
Patch Changes
v0.7.1Compare Source
Patch Changes
0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v0.7.0Compare Source
Minor Changes
46b4a72: BREAKING: When defining permission rules, it's now necessary to provide a ZodSchema that specifies the parameters the rule expects. This has been added to help better describe the parameters in the response of the metadata endpoint and to validate the parameters before a rule is executed.To help with this, we have also made a change to the API of permission rules. Before, the permission rules
toQueryandapplysignature expected parameters to be separate arguments, like so...The API has now changed to expect the parameters as a single object
One final change made is to limit the possible values for a parameter to primitives and arrays of primitives.
Patch Changes
9335ad1: Exported types for the .metadata endpoint of the permission routerbackstage/backstage (@backstage/plugin-proxy-backend)
v0.4.14Compare Source
Patch Changes
eae097c: Allow unauthenticated requests.v0.4.13Compare Source
Patch Changes
v0.4.12Compare Source
Patch Changes
1b4fd09: Updated dependencyyupto^1.0.0.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.4.11Compare Source
Patch Changes
1b4fd09: Updated dependencyyupto^1.0.0.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.4.10Compare Source
v0.4.9Compare Source
v0.4.8Compare Source
Patch Changes
v0.4.7Compare Source
Patch Changes
v0.4.6Compare Source
Patch Changes
v0.4.5Compare Source
Patch Changes
8613ba3: Switched to using"exports"field for/alphasubpath export.v0.4.4Compare Source
@backstage/backend-common@0.4.2
Patch Changes
5ecd50f: Fix HTTPS certificate generation and add new config switch, enabling it simply by settingbackend.https = true. Also introduces caching of generated certificates in order to avoid having to add a browser override every time the backend is restarted.00042e7: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit0829ff1: Tweaked development log formatter to include extra fields at the end of each log line036a843: Provide support for on-prem azure devopsad5c56f]036a843]@backstage/cli@0.4.5
Patch Changes
37a7d26: Use consistent file extensions for JS output when building packages.818d45e: Fix detection of external package child directories0588be0: Addbackend:bundlecommand for bundling a backend package with dependencies into a deployment archive.b8abdda: Add color to output fromversions:bumpin order to make it easier to spot changes. Also highlight possible breaking changes and link to changelogs.ad5c56f]@backstage/config-loader@0.4.1
Patch Changes
ad5c56f: Deprecate$dataand replace it with$includewhich allows for any type of json value to be read from external files. In addition,$includecan be used without a path, which causes the value at the root of the file to be loaded.Most usages of
$datacan be directly replaced with$include, except if the referenced value is not a string, in which case the value needs to be changed. For example:app-config.yaml
foo.yaml
bar.yaml
@backstage/core-api@0.2.9
Patch Changes
ab08923: Remove test dependencies from production package list@backstage/create-app@0.3.2
Patch Changes
c2b52d9: Replaceregister-componentplugin with newcatalog-importpluginfc6839f: Bumpsqlite3to v5.To apply this change to an existing app, change the version of
sqlite3in thedependenciesofpackages/backend/package.json:Note that the
sqlite3dependency may not be preset if you chose to use PostgreSQL when creating the app.8d68e4c: Removed the Circle CI sidebar item, since the target page does not exist.To apply this change to an existing app, remove
"CircleCI"sidebar item frompackages/app/src/sidebar.tsx, and theBuildIconimport if it is unused.1773a51: Removed lighthouse plugin from the default set up plugins, as it requires a separate Backend to function.To apply this change to an existing app, remove the following:
lighthouseblock fromapp-config.yaml.@backstage/plugin-lighthousedependency frompackages/app/package.json.@backstage/plugin-lighthousere-export frompackages/app/src/plugins.ts.packages/app/src/sidebar.tsx, and theRuleIconimport if it is unused.@backstage/integration@0.1.5
Patch Changes
036a843: Provide support for on-prem azure devops@backstage/techdocs-common@0.3.2
Patch Changes
7ec5254: 1. Added option to use AWS S3 as a choice to store the static generated files for TechDocs.f8ba88d: Fix forintegration.github.apiBaseUrlconfiguration not properly overriding apiBaseUrl used by techdocs00042e7: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit5ecd50f]00042e7]0829ff1]036a843]@backstage/plugin-auth-backend@0.2.9
Patch Changes
0289a05: Add support for the majority of the Core configurations for Passport-SAML.These configuration keys are supported:
As part of this change, there is also a fix to the redirection behaviour when doing load balancing and HTTPS termination - the application's baseUrl is used to generate the callback URL. For properly configured Backstage installations, no changes are necessary, and the baseUrl is respected.
Updated dependencies [
5ecd50f]Updated dependencies [
00042e7]Updated dependencies [
0829ff1]Updated dependencies [
036a843]@backstage/plugin-catalog@0.2.10
Patch Changes
9c09a36: Remove the unused dependency to@backstage/plugin-techdocs.8e083f4]947d3c2]@backstage/plugin-catalog-backend@0.5.2
Patch Changes
99be305: Fixed a bug where the catalog would read back all entities when adding a location that already exists.49d2016: Changelocation_update_logcolumns fromnvarchar(255)totext73e75ea: Add processor for ingesting AWS accounts from AWS Organizations071711d: Removesqlite3as a dependency. You may need to addsqlite3as a dependency of your backend if you were relying on this indirect dependency.5ecd50f]00042e7]0829ff1]036a843]@backstage/plugin-catalog-import@0.3.3
Patch Changes
edb7d07: Create "url" type location when registering using the catalog-import plugin.99be305]49d2016]9c09a36]73e75ea]036a843]071711d]@backstage/plugin-cost-insights@0.5.5
Patch Changes
ab08923: Remove test dependencies from production package list@backstage/plugin-pagerduty@0.2.5
Patch Changes
b7a1248: Optimize empty state image size.@backstage/plugin-rollbar-backend@0.1.6
Patch Changes
dde4ab3: Bumpaxiosfrom^0.20.0to^0.21.1.5ecd50f]00042e7]0829ff1]036a843]@backstage/plugin-scaffolder@0.3.6
Patch Changes
8e083f4: Bug fix: User can retry creating a new component if an error occurs, without having to reload the page.947d3c2: You can now maximize the logs into full-screen by clicking the button under each step of the job9c09a36]@backstage/plugin-scaffolder-backend@0.3.7
Patch Changes
37a5244: Add scaffolding support for Bitbucket Cloud and Server.00042e7: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit9efbc55: Add config schema for Bitbucket scaffolder5ecd50f]00042e7]0829ff1]036a843]@backstage/plugin-search@0.2.5
Patch Changes
0170743: Fix Material-UI warning for search filtering9c09a36]@backstage/plugin-sentry@0.3.2
Patch Changes
88da267: Port to new composability API by exporting newEntitySentryContentandEntitySentryCardcomponent extensions.9c09a36]@backstage/plugin-tech-radar@0.3.2
Patch Changes
ab08923: Remove test dependencies from production package listbc90917: Updated example data inREADME.@backstage/plugin-techdocs-backend@0.5.2
Patch Changes
7ec5254: 1. Added option to use AWS S3 as a choice to store the static generated files for TechDocs.7ec5254]5ecd50f]f8ba88d]00042e7]0829ff1]036a843]example-app@0.2.9
Patch Changes
ab08923]37a7d26]8e083f4]88da267]9c09a36]0170743]edb7d07]818d45e]0588be0]b8abdda]b7a1248]bc90917]947d3c2]v0.4.3Compare Source
Patch Changes
v0.4.2Compare Source
Patch Changes
v0.4.1Compare Source
Patch Changes
v0.4.0Compare Source
Minor Changes
71114ac: BREAKING: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
Patch Changes
02ba0a2: Add the route name to an error message that appears when the backendproxy wasn't well configured. This will help users to understand the
issue and fix the right configuration.
03691f0: Add back the legacy proxy config, to get secret redactionv0.3.2Compare Source
Patch Changes
v0.3.1Compare Source
@backstage/backend-common@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:8e2effb: Refactored UrlReader.readTree to be required and accept (url, options)Patch Changes
1722cb5: Added configuration schema7b37e68: Added the integration package1722cb5]7b37e68]@backstage/catalog-client@0.3.0
Minor Changes
717e43d: Changed the getEntities interface to (1) nest parameters in an object, (2) support field selection, and (3) return an object with an items field for future extension@backstage/cli@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:Patch Changes
1722cb5: Added configuration schema9023404: Support specifying listen host/port for frontend1722cb5]@backstage/config-loader@0.3.0
Minor Changes
1722cb5: Added support for loading and validating configuration schemas, as well as declaring config visibility through schemas.The new
loadConfigSchemafunction exported by@backstage/config-loaderallows for the collection and merging of configuration schemas from all nearby dependencies of the project.A configuration schema is declared using the
https://backstage.io/schema/config-v1JSON Schema meta schema, which is based on draft07. The only difference to the draft07 schema is the customvisibilitykeyword, which is used to indicate whether the given config value should be visible in the frontend or not. The possible values arefrontend,backend, andsecret, wherebackendis the default. A visibility ofsecrethas the same scope at runtime, but it will be treated with more care in certain contexts, and defining bothfrontendandsecretfor the same value in two different schemas will result in an error during schema merging.Packages that wish to contribute configuration schema should declare it in a root
"configSchema"field inpackage.json. The field can either contain an inlined JSON schema, or a relative path to a schema file. Schema files can be in either.jsonor.d.tsformat.TypeScript configuration schema files should export a single
Configtype, for example:@backstage/plugin-app-backend@0.3.0
Minor Changes
1722cb5: Use new config schema support to automatically inject config with frontend visibility, in addition to the existing env schema injection.This removes the confusing behavior where configuration was only injected into the app at build time. Any runtime configuration (except for environment config) in the backend used to only apply to the backend itself, and not be injected into the frontend.
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-cost-insights@0.4.0
Minor Changes
4040d4f: remove cost insights currency feature flagPatch Changes
1722cb5: Added configuration schema17a9f48: remove excessive margin from cost overview bannerf360395: UI improvements: Increase width of first column in product entity dialog tableUI improvement: Display full cost amount in product entity dialog table
259d848: Fix savings/excess display calculation1722cb5]@backstage/core@0.3.1
Patch Changes
1722cb5: Added configuration schema@backstage/create-app@0.2.2
Patch Changes
7d7abd5: Addapp-backendas a backend plugin, and make a single docker build of the backend the default way to deploy backstage.Note that the
app-backendcurrently only is a solution for deployments of the app, it's not a dev server and is not intended for local development.Template changes
Installing the
app-backendplugin in the backendDocker build setup
Should be the same as backend.baseUrl when using the
app-backendplugin@backstage/dev-utils@0.1.4
Patch Changes
1722cb5]1722cb5]9023404]@backstage/integration@0.1.1
Patch Changes
7b37e68: Added the integration package@backstage/test-utils@0.1.3
Patch Changes
1722cb5]1722cb5]9023404]@backstage/plugin-auth-backend@0.2.2
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]717e43d]@backstage/plugin-catalog@0.2.2
Patch Changes
8b7737d: Add About Card tooltips1722cb5]717e43d]@backstage/plugin-catalog-backend@0.2.1
Patch Changes
f531d30: An entity A, that exists in the catalog, can no longer be overwritten by registering a different location that also tries to supply an entity with the same kind+namespace+name. Writes of that new entity will instead be rejected with a log message similar toRejecting write of entity Component:default/artist-lookup from file:/Users/freben/dev/github/backstage/packages/catalog-model/examples/components/artist-lookup-component.yaml because entity existed from github:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-catalog-graphql@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-graphql-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-kubernetes-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-lighthouse@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-proxy-backend@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-rollbar@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-rollbar-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-scaffolder-backend@0.3.1
Patch Changes
d33f515: Extracted pushToRemote function for reuse between publishers1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-sentry@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]@backstage/plugin-sentry-backend@0.1.3
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-techdocs@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]8b7737d]@backstage/plugin-techdocs-backend@0.2.1
Patch Changes
1722cb5]1722cb5]7b37e68]8e2effb]@backstage/plugin-user-settings@0.2.2
Patch Changes
1722cb5: Added configuration schema1722cb5]example-app@0.2.2
Patch Changes
3efd03c: Removed obsolete CircleCI proxy config from example-app1722cb5]1722cb5]17a9f48]4040d4f]f360395]259d848]8b7737d]9023404]example-backend@0.2.2
Patch Changes
1722cb5]1722cb5]1722cb5]f531d30]3efd03c]7b37e68]8e2effb]d33f515]v0.3.0Compare Source
Minor Changes
7daf65b: Defining proxy endpoints directly under the rootproxyconfiguration key is deprecated. Endpoints should now be declared underproxy.endpointsinstead. TheskipInvalidProxiesandreviveConsumedRequestBodiescan now also be configured through static configuration.Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config4b82382: Fixed invalid configuration schema. The configuration schema may be more strict as a result.v0.2.41Compare Source
Patch Changes
v0.2.40Compare Source
Patch Changes
9598738: Marked headersAuthorizationandX-Api-Keyas secret in order to not show up in frontend configuration.v0.2.39Compare Source
Patch Changes
v0.2.38Compare Source
Patch Changes
v0.2.37Compare Source
Patch Changes
52b0022: Updated dependencymswto^1.0.0.3e3eea4: The proxy-backend plugin now supports reviving request bodies that have previously been consumed by an express middleware (e.g.express.json()). This is done by settingreviveConsumedRequestBodies: trueon the proxyRouterOptions. In order to preserve the current behavior, the proxy will not revive request bodies by default.The following is an example of a proxy
createRouterinvocation that revives request bodies:4acd93d: Ensure that@backstage/plugin-proxy-backendlogs the requests that it proxies when log level is set todebug.Updated dependencies
v0.2.36Compare Source
Patch Changes
0ff0331: Updated usage ofcreateBackendPlugin.4a6f38a: Added a Backend System plugin featurev0.2.35Compare Source
v0.2.34Compare Source
Patch Changes
backstage/backstage (@backstage/plugin-search)
v1.4.9Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.4.8Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.4.7Compare Source
Patch Changes
70ee3b7: Remove the hardcoded 'black' color give to the search type accordion icon as it doesn't work with dark themesf0464b0: Removes ADR from the default set of search filterscd872b9: Added ESLint ruleno-top-level-material-ui-4-importsin thesearchplugin to migrate the Material UI imports.v1.4.6Compare Source
Patch Changes
912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.8fe56a8: Widen@types/reactdependency range to include version 18.v1.4.5Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.4.4Compare Source
Patch Changes
03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.5814122: Updated/alphaexports to fit new naming patterns.8f5d6c1: Updates to the/alphaexports to match the extension input wrapping change.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.v1.4.3Compare Source
v1.4.2Compare Source
Patch Changes
68fc9dc: Updated alpha exports according to routing changes in@backstage/frontend-plugin-api.6c2b872: Add official support for React 18.62b5922: Internal theme type updatesfa11120: Fixed incorrect plugin ID in/alphaexport.71c97e7: Minor internal code cleanup.v1.4.1Compare Source
Patch Changes
v1.4.0Compare Source
Minor Changes
b78f570: The SearchPage component can now be configured via app-config.yaml with default query parameters to define how it behaves when it is first loaded or reset. Check out the following example:Acceptable values for
pageLimitare10,25,50or100.Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.8cec766: Removed@types/nodedependencyv1.3.6Compare Source
Patch Changes
v1.3.5Compare Source
v1.3.4Compare Source
Patch Changes
v1.3.3Compare Source
Patch Changes
c338140: Fixed bug in "View Full Results" link of Search Modal that did not navigate to the full results page.v1.3.2Compare Source
Patch Changes
e8c55c0: FixesSearchModalandHomePageSearchBarcomponents to use search bar reference value when "enter" is pressed, avoiding waiting for query state debounce.2f660eb: Fix SearchBar styles & update StoryBook stories for custom styles fornotchedOutlineclass.v1.3.1Compare Source
Patch Changes
v1.3.0Compare Source
Minor Changes
750e455: Add close button & improve search input.Material UI's Paper wrapping the SearchBar in the SearchPage was removed, we recommend users update their apps accordingly.
SearchBarBase's TextField's label support added & aria-label uses label string if present, tests relying on the default placeholder value should still work unless custom placeholder was given.
Patch Changes
0e3d8d6: Fixed 404 Error when fetching search results due to URL encoding changesv1.2.0Compare Source
Minor Changes
d6b73b0: Search modal auto closes on location changePatch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv1.1.1Compare Source
Patch Changes
6545487: Minor API report tweaks52b0022: Updated dependencymswto^1.0.0.v1.1.0Compare Source
Minor Changes
0eaa579: UpdateSearchModalcomponent to useSearchResultextensions.Patch Changes
26fb21a: Implement ashowCountsoption to display result counts per type inSearchType.Accordion66e2aab: Updated colors for each tab used on search modal, to improve color contrast. Aria label added to tabs wrapper component.disableRippleproperty on theTabcomponent removed to improve keyboard navigation indicator.v1.0.7Compare Source
Patch Changes
a24387c: When the search modal is opened, the focus is placed on the search bar input field.80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.v1.0.6Compare Source
Patch Changes
v1.0.5Compare Source
Patch Changes
2e701b3: Internal refactor to usereact-router-domrather thanreact-router.3280711: Updated dependencymswto^0.49.0.v1.0.4Compare Source
Patch Changes
v1.0.3Compare Source
Patch Changes
v1.0.2Compare Source
Patch Changes
817f319: Updated React Router dependencies to be peer dependencies.7d47def: Removed dependency on@types/jest.667d917: Updated dependencymswto^0.47.0.87ec2ba: Updated dependencymswto^0.46.0.bf5e903: Updated dependencymswto^0.45.0.18f6042: Use the newinheritParentContextIfAvailablesearch context property inSearchModalinstead of manually checking if a parent context exists, this conditional statement was previously duplicated in more than one component like inSearchBaras well and is now only done inSearchContextProvider.v1.0.1Compare Source
Patch Changes
v1.0.0Compare Source
Major Changes
7bd7d33: This package has been promoted to 1.0. Read more about what it means in New release: Backstage Search 1.0 blogPatch Changes
a70869e: Updated dependencymswto^0.43.0.8006d0f: Updated dependencymswto^0.44.0.509c409: To allow people to use a global search context in the search modal, the code for the search modal has been changed to only create a local search context if there is no parent context already defined.If you want to continue using a local context even if you define a global one, you will have to wrap the modal in a new local context manually:
Updated dependencies
backstage/backstage (@backstage/plugin-search-backend)
v1.5.6Compare Source
Patch Changes
v1.5.5Compare Source
Patch Changes
v1.5.4Compare Source
Patch Changes
2bd1410: Removed unused dependencies744c0cb: Update the router to use the newauthservices, it now accepts an optional discovery service option to get credentials for the permission service.v1.5.3Compare Source
Patch Changes
744c0cb: Update the router to use the newauthservices, it now accepts an optional discovery service option to get credentials for the permission service.v1.5.2Compare Source
v1.5.1Compare Source
Release v1.5.1
@backstage/plugin-scaffolder-backend@1.5.1
Patch Changes
vm2. This is to mitigate a sandbox escape recently discovered in thevm2library which provides the sandbox for the scaffolder and the templating functionality. Please make sure that thevm2version in your Backstage instance is at least 3.9.11.v1.5.0Compare Source
Minor Changes
126c2f9: Updates the OpenAPI spec to use plugin asinfo.titleinstead of package name.04907c3: Updates the OpenAPI specification title to plugin ID instead of package name.Patch Changes
3ed0eac: Authorized search engine now obeys query page limitv1.4.9Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv1.4.8Compare Source
Patch Changes
0cbb03b: Fixing regular expression ReDoS with zod packages. Upgrading to latest. ref: https://security.snyk.io/vuln/SNYK-JS-ZOD-5925617v1.4.7Compare Source
Patch Changes
6694b36: Update the OpenAPI spec with more complete error responses and request bodies using Optic. Also, updates the test cases to use the newsupertestpass through from@backstage/backend-openapi-utils.v1.4.6Compare Source
Patch Changes
16be6f9: Set the default length limit to search query to 100. To override it, definesearch.maxTermLengthin the config file.v1.4.5Compare Source
Patch Changes
v1.4.4Compare Source
v1.4.3Compare Source
Patch Changes
71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
Updated dependencies
v1.4.2Compare Source
Patch Changes
v1.4.1Compare Source
v1.4.0Compare Source
Minor Changes
ebeb775: Now performs request validation based on OpenAPI schema through@backstage/backend-openapi-utils. Error responses for invalid input, like"a"instead of a number, may have changed.Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config12a8c94: Add package repository and homepage metadata951ab6c: Add missingconfigSchemato package.jsonv1.3.3Compare Source
Patch Changes
v1.3.2Compare Source
Patch Changes
ee411e7: Update OpenAPI specs to be in line with linting standards.v1.3.1Compare Source
Patch Changes
021cfbb: Added an OpenAPI 3.0 spec and enforced schema-first model on the router.v1.3.0Compare Source
Minor Changes
1469daa: Exports search plugin that can be used with the new backend system. For documentation on how to migrate, check out the how to migrate to the new backend system guide.Patch Changes
1e4f5e9: Bumpzodandzod-to-json-schemadependencies.v1.2.4Compare Source
Patch Changes
v1.2.3Compare Source
Patch Changes
1b30c9a: Change the router's response to include the error message instead of its object type in case it fails during a search query because the messages have more info.v1.2.2Compare Source
This release fixes a issue in
@backstage/backend-commonwhere reading of S3 object would hang indefinitelyv1.2.1Compare Source
Patch Changes
bfd66b0: Allow max page limit for search results to be configurablev1.2.0Compare Source
Minor Changes
29ebc43: numberOfResults is now provided alongside the query resultPatch Changes
b05dcd5: Move thezoddependency to a version that does not collide with other librariesv1.1.1Compare Source
Patch Changes
v1.1.0Compare Source
Minor Changes
16c853a: Be less restrictive with unknown keys on query endpointa799972: The query received by search engines now contains a property calledpageLimit, it specifies how many results to return per page when sending a query request to the search backend.Example:
Returns up to 30 results per page
The search backend validates the page limit and this value must not exceed 100, but it doesn't set a default value for the page limit parameter, it leaves it up to each search engine to set this, so Lunr, Postgres and Elastic Search set 25 results per page as a default value.
Patch Changes
2d3a5f0: Useresponse.jsonrather thanresponse.sendwhere appropriate, as outlined inSECURITY.mdv1.0.2Compare Source
Patch Changes
v1.0.1Compare Source
Patch Changes
v1.0.0Compare Source
Major Changes
7bd7d33: This package has been promoted to 1.0. Read more about what it means in New release: Backstage Search 1.0 blogPatch Changes
a21cd43: If error isMissingIndexErrorwe return a 400 response with a more clear error message.backstage/backstage (@backstage/plugin-search-backend-module-pg)
v0.5.25Compare Source
Patch Changes
v0.5.24Compare Source
Patch Changes
v0.5.23Compare Source
Patch Changes
744c0cb: Start importingQueryTranslator,QueryRequestOptionsandSearchEnginefrom the@backstage/plugin-search-backend-node.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.22Compare Source
Patch Changes
744c0cb: Start importingQueryTranslator,QueryRequestOptionsandSearchEnginefrom the@backstage/plugin-search-backend-node.0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.v0.5.21Compare Source
v0.5.20Compare Source
v0.5.19Compare Source
Patch Changes
v0.5.18Compare Source
Patch Changes
v0.5.17Compare Source
Patch Changes
cc4228e: Switched module ID to use kebab-case.v0.5.16Compare Source
Patch Changes
2b4cd1c: Optimize outdated documents deletion logic in PgSearchEngine DatabaseDocumentStore which significantly reduces cost on large tables013611b:knexhas been bumped to major version 3 andbetter-sqlite3to major version 9, which deprecate node 16 support.v0.5.15Compare Source
Patch Changes
v0.5.14Compare Source
Patch Changes
v0.5.13Compare Source
v0.5.12Compare Source
Patch Changes
4ccf920: AddedindexerBatchSizeoption to be able to control the size of the batches being indexed. Also added a debug log entry to list out all the entities in the batch71114ac: The export for the new backend system has been moved to be thedefaultexport.For example, if you are currently importing the plugin using the following pattern:
It should be migrated to this:
Updated dependencies
v0.5.11Compare Source
Patch Changes
v0.5.10Compare Source
v0.5.9Compare Source
Patch Changes
629cbd1: UsecoreServices.rootConfiginstead ofcoreService.config12a8c94: Add package repository and homepage metadatav0.5.8Compare Source
Patch Changes
v0.5.7Compare Source
Patch Changes
3c09e8d: Updated Postgres search query filter in DatabaseDocumentStore to support field value search in array.v0.5.6Compare Source
Patch Changes
v0.5.5Compare Source
Patch Changes
1469daa: Search backend modules migrated to the new backend system. For documentation on how to migrate, check out the how to migrate to the new backend system guide.87ca22c: Fixed a bug that could cause orphaned PG connections to accumulate (eventuallyexhausting available connections) when errors were encountered earlier in the
search indexing process.
v0.5.4Compare Source
Patch Changes
v0.5.3Compare Source
Patch Changes
v0.5.2Compare Source
Patch Changes
v0.5.1Compare Source
Patch Changes
v0.5.0Compare Source
Minor Changes
e48fc1f: Added the option to pass a logger toPgSearchEngineduring instantiation. You may do so as follows:dff9843: The search engine now better handles the case when it receives 0 documents at index-time. Prior to this change, the indexer would replace any existing index with an empty index, effectively deleting it. Now instead, a warning is logged, and any existing index is left alone (preserving the index from the last successful indexing attempt).Patch Changes
c507aee: Ensured typescript type checks in migration files.v0.4.2Compare Source
Patch Changes
v0.4.1Compare Source
Patch Changes
a799972: The search engine has been updated to take advantage of thepageLimitproperty on search queries. If none is provided, the search engine will continue to use its default value of 25 results per page.v0.4.0Compare Source
Minor Changes
8872cc7: Fixed a bug in search-backend-module-pg where it ignores the skip migration database options when using the database.To use this new implementation you need to create the instance of
DatabaseDocumentStoreusing thePluginDatabaseManagerinstead ofKnex;Patch Changes
d669d89: Minor API signatures cleanupbackstage/backstage (@backstage/plugin-search-backend-node)
v1.2.20Compare Source
Patch Changes
v1.2.19Compare Source
Patch Changes
v1.2.18Compare Source
Patch Changes
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.744c0cb: ExportsQueryTranslator,QueryRequestOptionsandSearchEnginetypes. These new types were extracted from the@backstage/plugin-search-commonpackage and thetokenproperty was deprecated in favor of the a new credentials one.v1.2.17Compare Source
Patch Changes
0fb419b: Updated dependencyuuidto^9.0.0.Updated dependency
@types/uuidto^9.0.0.744c0cb: ExportsQueryTranslator,QueryRequestOptionsandSearchEnginetypes. These new types were extracted from the@backstage/plugin-search-commonpackage and thetokenproperty was deprecated in favor of the a new credentials one.v1.2.16Compare Source
v1.2.15Compare Source
v1.2.14Compare Source
Patch Changes
v1.2.13Compare Source
Patch Changes
v1.2.12Compare Source
Patch Changes
v1.2.11Compare Source
Patch Changes
b168d7e: Fix highlighting for non-string fields on theLunrsearch engine implementation.v1.2.10Compare Source
Patch Changes
v1.2.9Compare Source
Patch Changes
v1.2.8Compare Source
v1.2.7Compare Source
Patch Changes
v1.2.6Compare Source
Patch Changes
v1.2.5Compare Source
v1.2.4Compare Source
Patch Changes
12a8c94: Add package repository and homepage metadatae3e9bc1: Fix Lunr search engine highlight by ignoring invalid metadata positions.v1.2.3Compare Source
Patch Changes
v1.2.2Compare Source
Patch Changes
v1.2.1Compare Source
Patch Changes
v1.2.0Compare Source
Minor Changes
1469daa: Exports services and extension points that can be used with the new backend system. For documentation on how to migrate, check out the how to migrate to the new backend system guide.Patch Changes
v1.1.4Compare Source
Patch Changes
v1.1.3Compare Source
Patch Changes
v1.1.2Compare Source
v1.1.1Compare Source
Patch Changes
011bd51: Fixed spelling mistakes in documentation.v1.1.0Compare Source
Minor Changes
29ebc43: numberOfResults is now provided alongside the query resultdff9843: The search engine now better handles the case when it receives 0 documents at index-time. Prior to this change, the indexer would replace any existing index with an empty index, effectively deleting it. Now instead, a warning is logged, and any existing index is left alone (preserving the index from the last successful indexing attempt).Patch Changes
a962ce0: Wait for indexer initialization before finalizing indexing.de8a975: Changed to use nativeAbortControllerandAbortSignalfrom Node.js, insteadof the one from
node-abort-controller. This is possible now that the minimumsupported Node.js version of the project is 16.
Note that their interfaces are very slightly different, but typically not in a
way that matters to consumers. If you see any typescript errors as a direct
result from this, they are compatible with each other in the ways that we
interact with them, and should be possible to type-cast across without ill
effects.
683ced8: Fixed a bug that could cause amax listeners exceeded warningto be logged when more than 10 collators were running simultaneously.81b1e7b: Updated indexer and decorator base classes to take advantage of features introduced in Node.js v16; be sure you are running a supported version of Node.js.54c5836: Use ofTestPipeline.withSubject()is now deprecated. Instead, use thefromCollator,fromDecorator, orfromIndexerstatic methods to instantiate a test pipeline. You may also use the class'withCollator,withDecorator, andwithIndexerinstance methods to build test pipelines that consist of multiple test subjects.Updated dependencies
v1.0.4Compare Source
Patch Changes
v1.0.3Compare Source
Patch Changes
a799972: The search engine has been updated to take advantage of thepageLimitproperty on search queries. If none is provided, the search engine will continue to use its default value of 25 results per page.8006f8a: In order to improve the debuggability of the search indexing process, messages logged during indexing are now tagged with adocumentTypewhose value corresponds to thetypebeing indexed.v1.0.2Compare Source
Patch Changes
3f739be: Minor API signatures cleanupa1124ad: Fixed bug in LunrSearchEngine where stopwords in title is causing in-doc search not workingv1.0.1Compare Source
Patch Changes
v1.0.0Compare Source
Major Changes
7bd7d33: This package has been promoted to 1.0. Read more about what it means in New release: Backstage Search 1.0 blogPatch Changes
a21cd43: ExportsMissingIndexErrorthat can be used by the search engines for better error handling when missing index.backstage/backstage (@backstage/plugin-search-react)
v1.7.9Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.7.8Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv1.7.7Compare Source
Patch Changes
v1.7.6Compare Source
Patch Changes
8fe56a8: Widen@types/reactdependency range to include version 18.v1.7.5Compare Source
Patch Changes
v1.7.4Compare Source
Patch Changes
a5a0473: Internal refactor of alpha exports due to a change in how extension factories are defined.84dabc5: Removed@backstage/frontend-app-apidependency.5814122: Updated/alphaexports to fit new naming patterns.6f280fa: Capture analytics even when number of results is not available, since the total result count is not something that is always available for all search engines and configurations.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.v1.7.3Compare Source
v1.7.2Compare Source
Patch Changes
6c2b872: Add official support for React 18.f48cde8: Emit search analytics in the search hook instead of in a dedicated componentf75caf9: Fixed a rare occurrence where a race in the search bar could throw away user input or cause the clear button not to work.77f009b: Internal updates to match changes in the experimental@backstage/frontend-plugin-api.a539643: Minor refactor of search bar analytics capture71c97e7: The filter options passed toSearchResultGroupLayoutare now always explicitly rendered as strings by default.e7c09c4: Use default extensions boundary and suspense on the alpha declarativecreateSearchResultListItemextension factory.v1.7.1Compare Source
Patch Changes
v1.7.0Compare Source
Minor Changes
b78f570: The SearchPage component can now be configured via app-config.yaml with default query parameters to define how it behaves when it is first loaded or reset. Check out the following example:Acceptable values for
pageLimitare10,25,50or100.Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.45f8a95: Optionally initializes the search context with default settings for search queries only when the config is defined, rather than always overriding it.3d63e60: Internal restructure to avoid circular importsv1.6.4Compare Source
Patch Changes
v1.6.3Compare Source
Patch Changes
v1.6.2Compare Source
Patch Changes
0134c1a: Fix accessibility issue inSearchCheckboxcomponent, making it possible to use the field via keyboard.2f660eb: Fix SearchBar styles & update StoryBook stories for custom styles fornotchedOutlineclass.v1.6.1Compare Source
Patch Changes
v1.6.0Compare Source
Minor Changes
750e455: Add close button & improve search input.Material UI's Paper wrapping the SearchBar in the SearchPage was removed, we recommend users update their apps accordingly.
SearchBarBase's TextField's label support added & aria-label uses label string if present, tests relying on the default placeholder value should still work unless custom placeholder was given.
1ce7f84: accepts InputProp property that can override keys from defaultPatch Changes
f785f08:SearchPaginationnow automatically resets the page cursor when the page limit is changedadb3109: Fix text-overflow UI issue for Lifecycle spans in SearchFilter checkbox labels.v1.5.2Compare Source
Patch Changes
b2e182c: Fixes a UI bug in search result item which rendered the item text with incorrect font size and color8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv1.5.1Compare Source
Patch Changes
6545487: Minor API report tweaks553f3c9: Correctly disable next button inSearchPaginationon last pagev1.5.0Compare Source
Minor Changes
0eaa579: - Create the search results extensions, for more details see the documentation here;SearchResult,SearchResultListandSearchResultGroupcomponents to use extensions and default their props to optionally accept a query, when the query is not passed, the component tries to get it from the search context.Patch Changes
66e2aab:ListItemwrapper component moved toSearchResultListItemExtensionfor all*SearchResultListItemsthat are exported as extensions. This is to make sure the list only contains list elements.Note: If you have implemented a custom result list item, we recommend you to remove the list item wrapper to avoid nested
<li>elements.Updated dependencies
v1.4.0Compare Source
Minor Changes
6d9a93d: Allow customizing empty state component throughnoResultsComponentproperty.Example:
Patch Changes
80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.v1.3.1Compare Source
Patch Changes
v1.3.0Compare Source
Minor Changes
29ebc43: Thevalueof a search analytics event is now set as the total number of search results (when available)Patch Changes
2e701b3: Internal refactor to usereact-router-domrather thanreact-router.a19cffb: Update search links to only have header as linkable textv1.2.1Compare Source
Patch Changes
v1.2.0Compare Source
Minor Changes
4ed1fa2: The search query state now has an optionalpageLimitproperty that determines how many results will be requested per page, it defaults to 25.Examples:
Basic
With context
bed5a1d: The<SearchResultList />component now accepts an optional propertydisableRenderingWithNoResultsto disable rendering when no results are returned.Possibility to provide a custom no results component if needed through the
noResultsComponentproperty.Examples:
Rendering a custom no results component
Disable rendering when there are no results
3de4bd4: A<SearchPagination />component was created for limiting the number of results shown per search page. Use this new component to give users options to select how many search results they want to display per page. The default options are 10, 25, 50, 100.See examples below:
Basic
With context
6faaa05: The<SearchResultGroup />component now accepts an optional propertydisableRenderingWithNoResultsto disable rendering when no results are returned.Possibility to provide a custom no results component if needed through the
noResultsComponentproperty.Examples:
Rendering a custom no results component
Disable rendering when there are no results
Patch Changes
v1.1.0Compare Source
Minor Changes
97f2b8f: The<SearchResult/>component now accepts a optionalqueryprop to request results from the search api:Example:
Additionally, a search page can also be composed using these two new results layout components:
A
SearchResultListandSearchResultGroupcomponents were also created for users who have search pages with multiple queries, both are specializations ofSearchResultand also accept aqueryas a prop as well:18f6042: Provides search autocomplete functionality through aSearchAutocompletecomponent.A
SearchAutocompleteDefaultOptioncan also be used to render options with icons, primary texts, and secondary texts.Example:
ca8d5a6: We noticed a repeated check for the existence of a parent context before creating a child search context in more the one component such as Search Modal and Search Bar and to remove code duplication we extract the conditional to the context provider, now you can use it passing aninheritParentContextIfAvailableprop to theSearchContextProvider.Note: This added property does not create a local context if there is a parent context and in this case, you cannot use it together with
initialState, it will result in a type error because the parent context is already initialized.Patch Changes
817f319: Updated React Router dependencies to be peer dependencies.d3737da: Reset page cursor on search filter changev1.0.1Compare Source
Patch Changes
v1.0.0Compare Source
Major Changes
7bd7d33: This package has been promoted to 1.0. Read more about what it means in New release: Backstage Search 1.0 blogPatch Changes
60408ca: Fix search pagination to reset page cursor also when a term is cleared.backstage/backstage (@backstage/plugin-tech-radar)
v0.7.2Compare Source
Patch Changes
89b093f: Added ESLint ruleno-top-level-material-ui-4-importsin thetech-radarplugin to migrate the Material UI imports.e8f026a: Use ESM exports of react-use libraryv0.7.1Compare Source
Patch Changes
89b093f: Added ESLint ruleno-top-level-material-ui-4-importsin thetech-radarplugin to migrate the Material UI imports.e8f026a: Use ESM exports of react-use libraryv0.7.0Compare Source
Minor Changes
0453619: Fixed example snippet inREADME.mdto reflect correct timeline item order.Patch Changes
a2327ac: Fixed an issue with the "moved in direction" table header cell getting squished and becoming unreadable if a timeline description is too longv0.6.13Compare Source
Patch Changes
9aac2b0: Use--cwdas the firstyarnargument912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.8fe56a8: Widen@types/reactdependency range to include version 18.v0.6.12Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.6.11Compare Source
Patch Changes
03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.5814122: Updated/alphaexports to fit new naming patterns.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.v0.6.10Compare Source
Patch Changes
68fc9dc: Updated alpha exports according to routing changes in@backstage/frontend-plugin-api.6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.v0.6.9Compare Source
Patch Changes
0b55f77: Removed some unused dependenciesc09d2fa: Added experimental support for the declarative integration.9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v0.6.8Compare Source
Patch Changes
482bb5c: Moved@types/reactto be a regular dependencyb45d0ac: Add names to blip entry links in the radar to improve accessibility80b4d0b: Fixed the width of the tech radar dialog so that the content fits406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.6d35e9e: Add description property for Rings which will be shown in the footer.8cec766: Removed@types/nodedependencyc357f62: FixedRadarTimelinetext formatting.v0.6.7Compare Source
Patch Changes
v0.6.6Compare Source
Patch Changes
v0.6.5Compare Source
Patch Changes
v0.6.4Compare Source
Patch Changes
be4fa53: Fix description links when clicking entry in radar.v0.6.3Compare Source
Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.6.2Compare Source
Patch Changes
e14dcfa: Update colors to match Zalando's tech radar, also add coloring on title and legend to match ring color.cb8ec97: Change black & white colors to be theme aware52b0022: Updated dependencymswto^1.0.0.v0.6.1Compare Source
Patch Changes
v0.6.0Compare Source
Minor Changes
38fd519: Add highlighting of legend item and show bubble on hover within the Tech RadarPatch Changes
27a5e90: Small updates to some paragraph components to ensure theme typography properties are inherited correctly.80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.backstage/backstage (@backstage/plugin-user-settings)
v0.8.4Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.8.3Compare Source
Patch Changes
e8f026a: Use ESM exports of react-use libraryv0.8.2Compare Source
Patch Changes
ee584af: Added ESLint ruleno-top-level-material-ui-4-importsin theuser-settingsplugin to migrate the Material UI imports.v0.8.1Compare Source
Patch Changes
912ca7b: UseconvertLegacyRouteRefsto define routes in/alphaexport plugin.8fe56a8: Widen@types/reactdependency range to include version 18.d5b14a0: conditionally rendering the user name and email in user settings pagev0.8.0Compare Source
Minor Changes
56b2fb0: Updated the user settings selector to use a select component that displays native language names instead of language codes if possible.Patch Changes
eea0849: add user-settings declarative integration core nav item4016f21: Remove some unused dependenciesv0.7.14Compare Source
Patch Changes
03d0b6d: TheconvertLegacyRouteRefutility used by the alpha exports is now imported from@backstage/core-compat-api.a1227cc: Wrap/alphaexport extension elements in backwards compatibility wrapper.5814122: Updated/alphaexports to fit new naming patterns.8f5d6c1: Updates to the/alphaexports to match the extension input wrapping change.36c94b8: Refactor of the alpha exports due to API change in how extension IDs are constructed.fb8f3bd: Updated alpha translation message keys to use nested format and camel case.v0.7.13Compare Source
v0.7.12Compare Source
Patch Changes
68fc9dc: Updated alpha exports according to routing changes in@backstage/frontend-plugin-api.6c2b872: Add official support for React 18.4aa43f6: Updated dependencycross-fetchto^4.0.0.v0.7.11Compare Source
Patch Changes
18c8dee: Added experimental support for declarative integration via the/alphasubpath.d1b637d: Fixed a bug where the theme icons would not be colored according to their active state.9a1fce3: Updated dependency@testing-library/jest-domto^6.0.0.f95af4e: Updated dependency@testing-library/domto^9.0.0.v0.7.10Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.ce77b23: conditionally rendering the user email in user profile carde03f3ee: changed auto theme tooltip title to camel case8cec766: Removed@types/nodedependency6e30769: Introduced experimental support for internationalization.v0.7.9Compare Source
Skipped due to publishing issues.
v0.7.8Compare Source
Patch Changes
v0.7.7Compare Source
v0.7.6Compare Source
Patch Changes
v0.7.5Compare Source
Patch Changes
8174cf4: Fixing MUI / Material UI referencesv0.7.4Compare Source
Patch Changes
7a8441b: Reflect the updated sign on status for a provider after signing out.5362a7c: Improved the user experience of the feature flags list. It now sorts the enabled flags to the top of the list to increase the visibilities of the toggled flags.v0.7.3Compare Source
Patch Changes
473db60: Fix config schema definition.v0.7.2Compare Source
Patch Changes
8e00acb: Small tweaks to remove warnings in the console during development (mainly focusing on techdocs)e0c6e8b: Update peer dependenciesv0.7.1Compare Source
Patch Changes
4016f21: Remove some unused dependenciesv0.7.0Compare Source
Minor Changes
db10b6e: Added a Bitbucket Server Auth Provider and added its API to the app defaultsPatch Changes
c4940b6: Added a message to advise a page reload when toggling feature flagsv0.6.2Compare Source
Patch Changes
a942f70: Minor update to theUserSettingsIdentityCardto have clickable entity refsd61f622: Refactor for the feature flag filter functionality80ce4e8: Small updates to some components to ensure theme typography properties are inherited correctly.bca8e8b: Feature flags now accept a description property.v0.6.1Compare Source
Patch Changes
v0.6.0Compare Source
Minor Changes
29bdda5: Added the ability to fully customize settings page. Deprecated UserSettingsTab in favour of SettingsLayout.RoutePatch Changes
2e701b3: Internal refactor to usereact-router-domrather thanreact-router.3280711: Updated dependencymswto^0.49.0.19356df: Updated dependencyzen-observableto^0.9.0.c3fa90e: Updated dependencyzen-observableto^0.10.0.v0.5.1Compare Source
Patch Changes
v0.5.0Compare Source
Minor Changes
5543e86: BREAKING: TheapiRefpassed toProviderSettingsItemnow needs toimplement
ProfileInfoApi & SessionApi, rather than just the latter. This isunlikely to have an effect on most users though, since the builtin auth
providers generally implement both.
Fixed settings page showing providers as logged out when the user is using more
than one provider, and displayed some additional login information.
Patch Changes
06d61d1: Handle errors that may occur when the user logs out44c9a95: Prevent.set()to execute a request to the StorageClient if the user isguest174f02a: Update installation instructionsbackstage/backstage (@backstage/theme)
v0.5.2Compare Source
Patch Changes
6f4d2a0: ExporteddefaultTypographyto make adjusting these values in a custom theme easierv0.5.1Compare Source
Patch Changes
dd5d7cc: Fixed missing extra variables likeapplyDarkStylesin Mui V5 theme after callingcreateUnifiedThemeFromV4function8fe56a8: Widen@types/reactdependency range to include version 18.v0.5.0Compare Source
Minor Changes
4d9e3b3: Added a globalOverrideComponentNameToClassKeysfor other plugins and packages to populate using module augmentation. This will in turn will provide component style override types forcreateUnifiedTheme.Patch Changes
cd0dd4c: Align Material UI v5Papercomponent background color in dark mode to v4.v0.4.4Compare Source
Patch Changes
6c2b872: Add official support for React 18.v0.4.3Compare Source
Patch Changes
5ad5344: Added support for stringfontSizevalues (e.g."2.5rem") in themes in addition to numbers. Also added an optionalfontFamilyprop for header typography variants to allow further customization.v0.4.2Compare Source
Patch Changes
406b786: Mark package as being free of side effects, allowing more optimized Webpack builds.v0.4.1Compare Source
Patch Changes
4f28914: OverwritePaletteOptions&ThemeOptionstype to allow use ofcreateThemefrom@backstage/themeas well as@material-ui/core/styleswith the same type. Also replaced the defaultCSSBaselinewith v4 instead of v5 for better backwards compatibility for now.41c5aa0: Applying the modifiedtheme.spacingmethod only to overrides instead of replacing it in the whole theme.9395baa: You can now customize the typography of your theme by passing in your own custom typography defaults8174cf4: Fixing MUI / Material UI referencesf0444f0: Removed the hard coded color and background color in theMuiChipoverrides so that they work better with custom themes874c3e8: Override the spacing to a v5 compliant methodv0.4.0Compare Source
Minor Changes
1fd38bc: Material UI v5 Support: Adding platform-wide support for Material UI v5 allowing a transition phase for migrating central plugins & components over. We still support v4 instances & plugins by adding aTo allow the future support of plugins & components using Material UI v5 you want to upgrade your
AppTheme's to using theUnifiedThemeProviderPatch Changes
5065a5e: TweakedUnifiedThemeProviderto avoid overlapping JSS class names in production.v0.3.0Compare Source
Minor Changes
98c0c19: Updates light theme's primary foreground andrunningstatus indicator colours to meet WCAG. Previously #2E77D0 changed to #1F5493.Patch Changes
83b45f9: Fix accessibility issue with Backstage Table's header stylev0.2.19Compare Source
Patch Changes
303c2c3: AllowcloseButtoncolor inDismissableBannerto be configurable (via.theme.palette.banner.closeButtonColor)e0c6e8b: Update peer dependenciesv0.2.18Compare Source
Patch Changes
482dae5: Updated link to docs.v0.2.17Compare Source
Patch Changes
b7705e1: Use same table header color as @backstage/core-components Table to meet accessibility color contrast requirements. This change affects material-ui tables.spotify/web-scripts
v15.0.0Compare Source
chore
BREAKING CHANGES
14.1.6 (2023-02-14)
Bug Fixes
14.1.5 (2023-01-30)
Bug Fixes
14.1.4 (2023-01-19)
Bug Fixes
14.1.3 (2022-12-07)
Bug Fixes
14.1.2 (2022-12-02)
Bug Fixes
14.1.1 (2022-11-25)
Bug Fixes
v14.1.6Compare Source
Bug Fixes
v14.1.5Compare Source
Bug Fixes
v14.1.4Compare Source
Bug Fixes
v14.1.3Compare Source
Bug Fixes
v14.1.2Compare Source
Bug Fixes
v14.1.1Compare Source
Bug Fixes
v14.1.0Compare Source
Features
14.0.2 (2022-07-15)
Bug Fixes
14.0.1 (2022-07-12)
Bug Fixes
BREAKING CHANGES
v14.0.2Compare Source
Bug Fixes
v14.0.1Compare Source
Bug Fixes
BREAKING CHANGES
v14.0.0Compare Source
Bug Fixes
chore
BREAKING CHANGES
13.0.1 (2022-04-19)
Bug Fixes
v13.0.1Compare Source
Bug Fixes
v13.0.0Compare Source
Bug Fixes
chore
BREAKING CHANGES
testing-library/jest-dom
v6.4.2Compare Source
Bug Fixes
v6.4.1Compare Source
Bug Fixes
TestingLibraryMatchersfrom "./matchers" (#576) (dd1c4dd)v6.4.0Compare Source
Features
v6.3.0Compare Source
Features
v6.2.1Compare Source
Bug Fixes
v6.2.0Compare Source
Features
v6.1.6Compare Source
Bug Fixes
v6.1.5Compare Source
Bug Fixes
v6.1.4Compare Source
Bug Fixes
@adobe/css-toolsto4.3.1to address vulnerability (#532) (44f1eab)v6.1.3Compare Source
Bug Fixes
v6.1.2Compare Source
Bug Fixes
v6.1.1Compare Source
Bug Fixes
v6.1.0Compare Source
Features
v6.0.1Compare Source
Bug Fixes
v6.0.0Compare Source
Features
BREAKING CHANGES
the default import path or one of the new
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Renovate Bot.
ef50c5b014to76d7f26cc7