Skip to content

Latest commit

 

History

History
2282 lines (1749 loc) · 69.9 KB

v1.10.0-next.2-changelog.md

File metadata and controls

2282 lines (1749 loc) · 69.9 KB

Release v1.10.0-next.2

Major Changes

  • b4955ed7b9: Re-home some of the common types, components, hooks and scaffolderApiRef for the @backstage/plugin-scaffolder to this package for easy re-use across things that want to interact with the scaffolder.

Patch Changes

Minor Changes

Patch Changes

Minor Changes

  • 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.

Patch Changes

  • ecc6bfe4c9: Use new ServiceFactoryOrFunction type.
  • b99c030f1b: Moved over implementation of the root HTTP service from @backstage/backend-common, and replaced the middleware option with a configure callback option.
  • 150a7dd790: An error will now be thrown if attempting to override the plugin metadata service.
  • 015a6dced6: The createSpecializedBackend function will now throw an error if duplicate service implementations are provided.
  • e3fca10038: Tweaked the plugin logger to use plugin as the label for the plugin ID, rather than pluginId.
  • 8e06f3cf00: Switched imports of loggerToWinstonLogger to @backstage/backend-common.
  • Updated dependencies

Minor Changes

  • 8e06f3cf00: Moved loggerToWinstonLogger to @backstage/backend-common.

Patch Changes

  • ecc6bfe4c9: Added ServiceFactoryOrFunction type, for use when either a ServiceFactory or () => ServiceFactory can be used.
  • 02b119ff93: Added a new rootHttpRouterServiceRef and RootHttpRouterService interface.
  • 5437fe488f: Migrated types related to TokenManagerService, CacheService and DatabaseService into backend-plugin-api.
  • 16054afdec: Documented coreServices an all of its members.
  • 62b04bb865: Updates all create* methods to simplify their type definitions and ensure they all have configuration interfaces.
  • Updated dependencies

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

  • bc18c902a2: Add --preview-app-bundle-path and --preview-app-port options to the serve command enabling previewing with apps other than the provided one

Patch Changes

Minor Changes

  • 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.

Patch Changes

Minor Changes

  • 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
      

Patch Changes

Minor Changes

  • 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>

Patch Changes

Minor Changes

  • 38fd519fc1: Add highlighting of legend item and show bubble on hover within the Tech Radar

Patch Changes

Patch Changes

  • 8e06f3cf00: Added loggerToWinstonLogger, which was moved from @backstage/backend-plugin-api.
  • 2b1554cebf: Replaced dependencies on the 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.
  • 5437fe488f: Migrated types related to TokenManagerService, CacheService and DatabaseService into backend-plugin-api.
  • d592ec4f51: Updated the logger created by createRootLogger to make it possible to override the default service log label.
  • b99c030f1b: Refactor to rely on @backstage/backend-app-api for the implementation of createServiceBuilder.
  • f23eef3aa2: Updated dependency better-sqlite3 to ^8.0.0.
  • Updated dependencies

Patch Changes

  • ecc6bfe4c9: Use new ServiceFactoryOrFunction type.
  • 015a6dced6: Updated to make sure that service implementations replace default service implementations.
  • 02b119ff93: The new root HTTP router service is now installed by default.
  • Updated dependencies

Patch Changes

Patch Changes

Patch Changes

  • e23f13a573: Enable the by-refs endpoint to receive fields through the POST body as well as through query parameters.
  • Updated dependencies

Patch Changes

Patch Changes

Patch Changes

  • 016a52c28f: 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

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

  • 0358d399ad: Updated dependency ts-morph to ^17.0.0.
  • Updated dependencies

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

  • 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

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes