docs/releases/v1.10.0-next.2-changelog.md
scaffolderApiRef for the @backstage/plugin-scaffolder to this package for easy re-use across things that want to interact with the scaffolder.02b119ff93: BREAKING: The httpRouterFactory now accepts a getPath option rather than indexPlugin. To set up custom index path, configure the new rootHttpRouterFactory with a custom indexPath instead.
Added an implementation for the new rootHttpRouterServiceRef.
ServiceFactoryOrFunction type.@backstage/backend-common, and replaced the middleware option with a configure callback option.createSpecializedBackend function will now throw an error if duplicate service implementations are provided.plugin as the label for the plugin ID, rather than pluginId.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.ServiceFactoryOrFunction type, for use when either a ServiceFactory or () => ServiceFactory can be used.rootHttpRouterServiceRef and RootHttpRouterService interface.TokenManagerService, CacheService and DatabaseService into backend-plugin-api.coreServices an all of its members.create* methods to simplify their type definitions and ensure they all have configuration interfaces.--preview-app-bundle-path and --preview-app-port options to the serve command enabling previewing with apps other than the provided onee4469d0ec1: The ADR plugin can now work with sites other than GitHub. Expanded the ADR backend plugin to provide endpoints to facilitate this.
BREAKING The ADR plugin now uses UrlReaders. You will have to configure integrations for all sites you want to get ADRs from. If you would like to create your own implementation that has different behavior, you can override the AdrApi just like you can with other apis. The previously used Octokit implementation has been completely removed.
b4955ed7b9: - Deprecation - Deprecated the following exports, please import them directly from @backstage/plugin-scaffolder-react instead
createScaffolderFieldExtension
ScaffolderFieldExtensions
useTemplateSecrets
scaffolderApiRef
ScaffolderApi
ScaffolderUseTemplateSecrets
TemplateParameterSchema
CustomFieldExtensionSchema
CustomFieldValidator
FieldExtensionOptions
FieldExtensionComponentProps
FieldExtensionComponent
ListActionsResponse
LogEvent
ScaffolderDryRunOptions
ScaffolderDryRunResponse
ScaffolderGetIntegrationsListOptions
ScaffolderGetIntegrationsListResponse
ScaffolderOutputlink
ScaffolderScaffoldOptions
ScaffolderScaffoldResponse
ScaffolderStreamLogsOptions
ScaffolderTask
ScaffolderTaskOutput
ScaffolderTaskStatus
Deprecation - Deprecated the rootRouteRef export, this should now be used from scaffolderPlugin.routes.root
The following /alpha types have removed from this package and moved to the @backstage/plugin-scaffolder-react/alpha package
createNextScaffolderFieldExtension
FormProps
NextCustomFieldValidator
NextFieldExtensionComponentProps
NextFieldExtensionOptions
MarkdownContent component. This will allow the page to show richer content to describe scaffolder actions.use-immer to ^0.8.0.6d9a93def8: Allow customizing empty state component through noResultsComponent property.
Example:
<SearchResult noResultsComponent={<>No results were found</>}>
{({ results }) => (
<List>
{results.map(({ type, document }) => {
switch (type) {
case 'custom-result-item':
return (
<CustomResultListItem
key={document.location}
result={document}
/>
);
default:
return (
<DefaultResultListItem
key={document.location}
result={document}
/>
);
}
})}
</List>
)}
</SearchResult>
loggerToWinstonLogger, which was moved from @backstage/backend-plugin-api.Logger type from winston with LoggerService from @backstage/backend-plugin-api. This is not a breaking change as the LoggerService is a subset of the Logger interface.TokenManagerService, CacheService and DatabaseService into backend-plugin-api.createRootLogger to make it possible to override the default service log label.@backstage/backend-app-api for the implementation of createServiceBuilder.better-sqlite3 to ^8.0.0.ServiceFactoryOrFunction type.startTestBackend setup now includes default implementations for all core services.better-sqlite3 to ^8.0.0.by-refs endpoint to receive fields through the POST body as well as through query parameters.type-fest016a52c28f: Bumped the minimum version of better-sqlite3. You can make the following change to your packages/backend/package.json to keep your instance of Backstage updated.
- "better-sqlite3": "^7.5.0",
+ "better-sqlite3": "^8.0.0",
Updated dependencies
e4469d0ec1: The ADR plugin can now work with sites other than GitHub. Expanded the ADR backend plugin to provide endpoints to facilitate this.
BREAKING The ADR plugin now uses UrlReaders. You will have to configure integrations for all sites you want to get ADRs from. If you would like to create your own implementation that has different behavior, you can override the AdrApi just like you can with other apis. The previously used Octokit implementation has been completely removed.
21ffbdd5ee: Clarify that default ADR parsers support MADR specification v2.x
Updated dependencies
@apollo/explorer to ^2.0.0.loggerToWinstonLogger to @backstage/backend-common.ts-morph to ^17.0.0.by-refs endpoint to receive fields through the POST body as well as through query parameters.better-sqlite3 to ^8.0.0.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.catalogPath option to properly glob match on received GitHub events.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.EntityPeekAheadPopover component. It shows more details about the associated entity. See the playbook here https://backstage.io/storybook/?path=/story/catalog-entitypeekaheadpopover--defaultloggerToWinstonLogger to @backstage/backend-common.loggerToWinstonLogger to @backstage/backend-common.swr to ^2.0.0.swr to ^2.0.0.2fadff2a25: Change scaffolder task actions to include markdown to demonstrate the new ActionsPage markdown feature.
b44eb68bcb: This patch adds changes to provide examples alongside scaffolder task actions.
The createTemplateAction function now takes a list of examples e.g.
const actionExamples = [
{
description: 'Example 1',
example: yaml.stringify({
steps: [
{
action: 'test:action',
id: 'test',
input: {
input1: 'value',
},
},
],
}),
},
];
export function createTestAction() {
return createTemplateAction({
id: 'test:action',
examples: [
{
description: 'Example 1',
examples: actionExamples
}
],
...,
});
These examples can be retrieved later from the api.
curl http://localhost:7007/api/scaffolder/v2/actions
[
{
"id": "test:action",
"examples": [
{
"description": "Example 1",
"example": "steps:\n - action: test:action\n id: test\n input:\n input1: value\n"
}
],
"schema": {
"input": {
"type": "object",
"properties": {
"input1": {
"title": "Input 1",
"type": "string"
}
}
}
}
}
]
8e06f3cf00: Switched imports of loggerToWinstonLogger to @backstage/backend-common.
Updated dependencies
ActionsPage markdown feature.ElasticSearchSearchEngine.newClient() method.