github backstage/backstage release-2021-07-22
on GitHub

latest releases: v1.33.0-next.3, v1.33.0-next.2, v1.32.5...
3 years ago

@backstage/techdocs-common@0.7.0

Minor Changes

  • d32d01e5b: Improve the annotation backstage.io/techdocs-ref: dir:<relative-target> that links to a path that is relative to the source of the annotated entity.
    This annotation works with the basic and the recommended flow, however, it will be most useful with the basic approach.

    This change remove the deprecation of the dir reference and provides first-class support for it.
    In addition, this change removes the support of the deprecated github, gitlab, and azure/api locations from the dir reference preparer.

    Example Usage

    The annotation is convenient if the documentation is stored in the same location, i.e. the same git repository, as the catalog-info.yaml.
    While it is still supported to add full URLs such as backstage.io/techdocs-ref: url:https://... for custom setups, documentation is mostly stored in the same repository as the entity definition.
    By automatically resolving the target relative to the registration location of the entity, the configuration overhead for this default setup is minimized.
    Since it leverages the @backstage/integrations package for the URL resolution, this is compatible with every supported source.

    Consider the following examples:

    1. "I have a repository with a single catalog-info.yaml and a TechDocs page in the root folder!"

      https://github.com/backstage/example/tree/main/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: example
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml

    2. "I have a repository with a single catalog-info.yaml and my TechDocs page in located in a folder!"

      https://bitbucket.org/my-owner/my-project/src/master/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: example
      | > annotations:
      | > backstage.io/techdocs-ref: dir:./some-folder # -> subfolder
      | > spec: {}
      |- some-folder/
      |- docs/
      |- mkdocs.yml

    3. "I have a mono repository that hosts multiple components!"

      https://dev.azure.com/organization/project/_git/repository
      |- my-1st-module/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: my-1st-module
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml
      |- my-2nd-module/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: my-2nd-module
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Location
      | > metadata:
      | > name: example
      | > spec:
      | > targets:
      | > - ./*/catalog-info.yaml

Patch Changes

## @backstage/plugin-git-release-manager@0.2.0

Minor Changes

  • a2d8922c9: Enable users to add custom features

    Add more metadata to success callbacks

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.1.6

## @backstage/plugin-techdocs-backend@0.9.0

Minor Changes

  • d32d01e5b: Improve the annotation backstage.io/techdocs-ref: dir:<relative-target> that links to a path that is relative to the source of the annotated entity.
    This annotation works with the basic and the recommended flow, however, it will be most useful with the basic approach.

    This change remove the deprecation of the dir reference and provides first-class support for it.
    In addition, this change removes the support of the deprecated github, gitlab, and azure/api locations from the dir reference preparer.

    Example Usage

    The annotation is convenient if the documentation is stored in the same location, i.e. the same git repository, as the catalog-info.yaml.
    While it is still supported to add full URLs such as backstage.io/techdocs-ref: url:https://... for custom setups, documentation is mostly stored in the same repository as the entity definition.
    By automatically resolving the target relative to the registration location of the entity, the configuration overhead for this default setup is minimized.
    Since it leverages the @backstage/integrations package for the URL resolution, this is compatible with every supported source.

    Consider the following examples:

    1. "I have a repository with a single catalog-info.yaml and a TechDocs page in the root folder!"

      https://github.com/backstage/example/tree/main/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: example
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml

    2. "I have a repository with a single catalog-info.yaml and my TechDocs page in located in a folder!"

      https://bitbucket.org/my-owner/my-project/src/master/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: example
      | > annotations:
      | > backstage.io/techdocs-ref: dir:./some-folder # -> subfolder
      | > spec: {}
      |- some-folder/
      |- docs/
      |- mkdocs.yml

    3. "I have a mono repository that hosts multiple components!"

      https://dev.azure.com/organization/project/_git/repository
      |- my-1st-module/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: my-1st-module
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml
      |- my-2nd-module/
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Component
      | > metadata:
      | > name: my-2nd-module
      | > annotations:
      | > backstage.io/techdocs-ref: dir:. # -> same folder
      | > spec: {}
      |- docs/
      |- mkdocs.yml
      |- catalog-info.yaml
      | > apiVersion: backstage.io/v1alpha1
      | > kind: Location
      | > metadata:
      | > name: example
      | > spec:
      | > targets:
      | > - ./*/catalog-info.yaml

Patch Changes

  • 9266b80ab: Implements tech docs collator to retrieve and expose search indexes for entities that have tech docs configured
  • Updated dependencies
    • @backstage/techdocs-common@0.7.0
    • @backstage/catalog-client@0.3.17
    • @backstage/backend-common@0.8.7

## @backstage/backend-common@0.8.7

Patch Changes

  • f25357273: Implement the etag functionality in the readUrl method of FetchUrlReader.

  • bdd6ab5f1: It's possible to customize the request logging handler when building the service. For example in your backend 

      const service = createServiceBuilder(module)
    .loadConfig(config)
    .setRequestLoggingHandler((logger?: Logger): RequestHandler => {
      const actualLogger = (logger || getRootLogger()).child({
        type: 'incomingRequest',
      });
      return expressWinston.logger({ ...

## @backstage/catalog-client@0.3.17

Patch Changes

  • 71c936eb6: Export CatalogRequestOptions type

## @backstage/cli@0.7.5

Patch Changes

  • 9a96b5da7: chore: bump eslint to 7.30.0

## @backstage/codemods@0.1.6

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.1.6
    • @backstage/core-app-api@0.1.5

## @backstage/core-app-api@0.1.5

Patch Changes

  • ea249c6e6: Fix a bug in FlatRoutes that prevented outlets from working with the root route, as well as matching root routes too broadly.
  • Updated dependencies
    • @backstage/core-components@0.1.6

## @backstage/core-components@0.1.6

Patch Changes

  • 9a751bb28: Increase the vertical padding of the sidebar search input field to match the height of the parent anchor tag. This prevents users from accidentally navigating to the search page when they actually wanted to use the search input directly.

  • 45b5fc3a8: Updated the layout of catalog and API index pages to handle smaller screen sizes. This adds responsive wrappers to the entity tables, and switches filters to a drawer when width-constrained. If you have created a custom catalog or API index page, you will need to update the page structure to match the updated catalog customization documentation.

  • 03bf17e9b: Improve the responsiveness of the EntityPage UI. With this the Header component should scale with the screen size & wrapping should not cause overflowing/blocking of links. Additionally enforce the Pages using the Grid Layout to use it across all screen sizes & to wrap as intended.

    To benefit from the improved responsive layout, the EntityPage in existing Backstage applications should be updated to set the xs column size on each grid item in the page, as this does not default. For example:

    ```diff



    • ## @backstage/create-app@0.3.32 ### Patch Changes - 03bf17e9b: Improve the responsiveness of the EntityPage UI. With this the Header component should scale with the screen size & wrapping should not cause overflowing/blocking of links. Additionally enforce the Pages using the Grid Layout to use it across all screen sizes & to wrap as intended. To benefit from the improved responsive layout, the `EntityPage` in existing Backstage applications should be updated to set the `xs` column size on each grid item in the page, as this does not default. For example: diff
      -
      +
      ```

  • eb740ee24: Moved sample software templates to the backstage/software-templates repository. If you previously referenced the sample templates straight from scaffolder-backend plugin in the main backstage/backstage repository in your app-config.yaml, these references will need to be updated.

    See https://github.com/backstage/software-templates

## @backstage/dev-utils@0.2.3

Patch Changes

  • 01001a324: Allow custom theme for dev app.
  • Updated dependencies
    • @backstage/core-components@0.1.6
    • @backstage/plugin-catalog-react@0.3.1
    • @backstage/core-app-api@0.1.5
    • @backstage/test-utils@0.1.15

## @backstage/test-utils@0.1.15

Patch Changes

  • 45b5fc3a8: Updated the layout of catalog and API index pages to handle smaller screen sizes. This adds responsive wrappers to the entity tables, and switches filters to a drawer when width-constrained. If you have created a custom catalog or API index page, you will need to update the page structure to match the updated catalog customization documentation.
  • Updated dependencies
    • @backstage/core-app-api@0.1.5

## @backstage/plugin-api-docs@0.6.3

Patch Changes

  • 45b5fc3a8: Updated the layout of catalog and API index pages to handle smaller screen sizes. This adds responsive wrappers to the entity tables, and switches filters to a drawer when width-constrained. If you have created a custom catalog or API index page, you will need to update the page structure to match the updated catalog customization documentation.
  • Updated dependencies
    • @backstage/core-components@0.1.6
    • @backstage/plugin-catalog@0.6.8
    • @backstage/plugin-catalog-react@0.3.1

## @backstage/plugin-auth-backend@0.3.18

Patch Changes

  • 2567c066d: TokenIssuer is now exported so it may be used by auth providers that are not bundled with Backstage
  • Updated dependencies
    • @backstage/catalog-client@0.3.17
    • @backstage/backend-common@0.8.7
    • @backstage/test-utils@0.1.15

## @backstage/plugin-catalog@0.6.8

Patch Changes

  • 221d7d060: added retry callback to useEntity hook

  • 45b5fc3a8: Updated the layout of catalog and API index pages to handle smaller screen sizes. This adds responsive wrappers to the entity tables, and switches filters to a drawer when width-constrained. If you have created a custom catalog or API index page, you will need to update the page structure to match the updated catalog customization documentation.

  • 71c936eb6: Export CatalogClientWrapper class

  • 03bf17e9b: Improve the responsiveness of the EntityPage UI. With this the Header component should scale with the screen size & wrapping should not cause overflowing/blocking of links. Additionally enforce the Pages using the Grid Layout to use it across all screen sizes & to wrap as intended.

    To benefit from the improved responsive layout, the EntityPage in existing Backstage applications should be updated to set the xs column size on each grid item in the page, as this does not default. For example:

    ```diff



    • - Updated dependencies - @backstage/core-components@0.1.6 - @backstage/catalog-client@0.3.17 - @backstage/plugin-catalog-react@0.3.1 ## @backstage/plugin-catalog-import@0.5.14 ### Patch Changes - 903f3323c: Fix heading that wrongly implied catalog-import supports entity discovery for multiple integrations. - Updated dependencies - @backstage/core-components@0.1.6 - @backstage/catalog-client@0.3.17 - @backstage/plugin-catalog-react@0.3.1 ## @backstage/plugin-catalog-react@0.3.1 ### Patch Changes - 221d7d060: added retry callback to useEntity hook - Updated dependencies - @backstage/core-components@0.1.6 - @backstage/catalog-client@0.3.17 - @backstage/core-app-api@0.1.5 ## @backstage/plugin-jenkins-backend@0.1.2 ### Patch Changes - eee05803a: Update `@backstage/backend-common` to `^0.8.6` - Updated dependencies - @backstage/catalog-client@0.3.17 - @backstage/backend-common@0.8.7 ## @backstage/plugin-kubernetes-backend@0.3.11 ### Patch Changes - 5bd57f8f5: Support assume role on kubernetes api configuration for AWS. - Updated dependencies - @backstage/backend-common@0.8.7 ## @backstage/plugin-scaffolder-backend@0.14.1 ### Patch Changes - c73f53bc2: Add new built-in action github:actions:dispatch - 7cea90592: - Move out the `cookiecutter` templating to its own module that is depended on by the `scaffolder-backend` plugin. No breaking change yet, but we will drop first class support for `cookiecutter` in the future and it will become an opt-in feature. - eb740ee24: Moved sample software templates to the [backstage/software-templates](https://github.com/backstage/software-templates) repository. If you previously referenced the sample templates straight from `scaffolder-backend` plugin in the main [backstage/backstage](https://github.com/backstage/backstage) repository in your `app-config.yaml`, these references will need to be updated. See <https://github.com/backstage/software-templates> - Updated dependencies - @backstage/catalog-client@0.3.17 - @backstage/backend-common@0.8.7 ## @backstage/plugin-search@0.4.4 ### Patch Changes - 9266b80ab: Adding a type filter to new search - Updated dependencies - @backstage/core-components@0.1.6 - @backstage/plugin-catalog-react@0.3.1 ## @backstage/plugin-techdocs@0.10.1 ### Patch Changes - 9266b80ab: Add search list item to display tech docs search results - 03bf17e9b: Improve the responsiveness of the EntityPage UI. With this the Header component should scale with the screen size & wrapping should not cause overflowing/blocking of links. Additionally enforce the Pages using the Grid Layout to use it across all screen sizes & to wrap as intended. To benefit from the improved responsive layout, the `EntityPage` in existing Backstage applications should be updated to set the `xs` column size on each grid item in the page, as this does not default. For example: diff
      -
      +
      ```

  • 378cc6a54: Only update the path when the content is updated.
    If content and path are updated independently, the frontend rendering is triggered twice on each navigation: Once for the path change (with the old content) and once for the new content.
    This might result in a flickering rendering that is caused by the async frontend preprocessing, and the fact that replacing the shadow dom content is expensive.

  • 214e7c52d: Refactor the techdocs transformers to return Promises and await all transformations.

  • e35b13afa: Handle error responses in getTechDocsMetadata and getEntityMetadata such that <TechDocsPageHeader> doesn't throw errors.

  • Updated dependencies

    • @backstage/core-components@0.1.6
    • @backstage/plugin-catalog-react@0.3.1

## @backstage/plugin-user-settings@0.3.1

Patch Changes

  • b5953c1df: Aligns switch left and allows clicking on rows
  • Updated dependencies
    • @backstage/core-components@0.1.6

## example-backend@0.2.38

Patch Changes

  • Updated dependencies
    • @backstage/plugin-kubernetes-backend@0.3.11
    • @backstage/catalog-client@0.3.17
    • @backstage/plugin-auth-backend@0.3.18
    • @backstage/plugin-jenkins-backend@0.1.2
    • @backstage/backend-common@0.8.7
    • @backstage/plugin-techdocs-backend@0.9.0
    • @backstage/plugin-scaffolder-backend@0.14.1
Check out latest releases or
releases around backstage/backstage release-2021-07-22

Don't miss a new backstage release

NewReleases is sending notifications on new releases.

Get notifications