github backstage/backstage release-2021-04-15
on GitHub

latest releases: v1.27.2, v1.27.1, v1.27.0...
3 years ago

@backstage/techdocs-common@0.5.0

Minor Changes

  • bc9d62f4f: Move the sanity checks of the publisher configurations to a dedicated PublisherBase#getReadiness() method instead of throwing an error when doing Publisher.fromConfig(...).
    You should include the check when your backend to get early feedback about a potential misconfiguration:

    ```diff
    // packages/backend/src/plugins/techdocs.ts

    export default async function createPlugin({ 

    logger,
config,
discovery,
reader,

    }: PluginEnvironment): Promise { 

    // ...


const publisher = await Publisher.fromConfig(config, {
  logger,
  discovery,
})

    • // checks if the publisher is working and logs the result

    • await publisher.getReadiness();

      // Docker client (conditionally) used by the generators, based on techdocs.generators config.
      const dockerClient = new Docker();

      // ...
      } 

      If you want to crash your application on invalid configurations, you can throw an `Error` to preserve the old behavior.
Please be aware that this is not the recommended for the use in a Backstage backend but might be helpful in CLI tools such as the `techdocs-cli`.
```ts
const publisher = await Publisher.fromConfig(config, {
logger,
discovery,
});
const ready = await publisher.getReadiness();
if (!ready.isAvailable) {
throw new Error('Invalid TechDocs publisher configuration');
}

Patch Changes

  • Updated dependencies [bb5055aee]
  • Updated dependencies [5d0740563]
    • @backstage/catalog-model@0.7.7

## @backstage/plugin-scaffolder@0.9.0

Minor Changes

  • a360f9478: Expose the catalog-import route as an external route from the scaffolder.

    This will make it possible to hide the "Register Existing Component" button
    when you for example are running backstage with catalog.readonly=true.

    As a consequence of this change you need add a new binding to your createApp call to
    keep the button visible. However, if you instead want to hide the button you can safely
    ignore the following example.

    To bind the external route from the catalog-import plugin to the scaffolder template
    index page, make sure you have the appropriate imports and add the following
    to the createApp call: 

    import { catalogImportPlugin } from '@backstage/plugin-catalog-import';


const app = createApp({
  // ...
  bindRoutes({ bind }) {
    // ...
    bind(scaffolderPlugin.externalRoutes, {
      registerComponent: catalogImportPlugin.routes.importPage,
    });
  },
});

    Patch Changes

    • Updated dependencies [bb5055aee]

    • Updated dependencies [d0d1c2f7b]

    • Updated dependencies [5d0740563]

    • Updated dependencies [5cafcf452]

    • Updated dependencies [86a95ba67]

    • Updated dependencies [442f34b87]

    • Updated dependencies [e27cb6c45]

    • @backstage/catalog-model@0.7.7

    • @backstage/core@0.7.5

    • @backstage/catalog-client@0.3.10

      @backstage/catalog-client@0.3.10

      Patch Changes

    • 442f34b87: Make sure the CatalogClient escapes URL parameters correctly.

    • Updated dependencies [bb5055aee]

    • Updated dependencies [5d0740563]

    • @backstage/catalog-model@0.7.7

      @backstage/catalog-model@0.7.7

      Patch Changes

    • bb5055aee: Add getEntitySourceLocation helper

    • 5d0740563: Implemented missing support for the dependsOn/dependencyOf relationships
      between Component and Resource catalog model objects.
      Added support for generating the relevant relationships to the
      BuiltinKindsEntityProcessor, and added simple support for fetching
      relationships between Components and Resources for rendering in the
      system diagram. All catalog-model changes backwards compatible.

      @backstage/cli@0.6.8

      Patch Changes

    • 60ce64aa2: Disable hot reloading in CI environments.

      @backstage/core@0.7.5

      Patch Changes

    • d0d1c2f7b: Pass inverse prop to Gauge from GaugeCard

    • 5cafcf452: add debounce time attribute for apis-docs for search, giving more time to the users when they are typing.

    • 86a95ba67: exposes undocumented PageTheme

    • e27cb6c45: Don't use a drag & drop cursor when clicking on disabled IconLinkVertical.

      @backstage/create-app@0.3.18

      Patch Changes

    • b49a525ab: Fixing dependency resolution for problematic library graphql-language-service-interface.
      This change might not have to be applied to your local installation, however if you run into this error:
      Error: Failed to compile.
      /tmp/backstage-e2e-uMeycm/test-app/node_modules/graphql-language-service-interface/esm/GraphQLLanguageService.js 100:23
      Module parse failed: Unexpected token (100:23)
      You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file. See https://webpack.js.org/concepts#loaders
      | }
      | let customRules = null; 

          if (extensions?.customValidationRules &&

      | typeof extensions.customValidationRules === 'function') {
      | customRules = extensions.customValidationRules(this._graphQLConfig);
      You can fix it by adding the following to the root package.json. 

      ...
"resolutions": {
"graphql-language-service-interface": "2.8.2",
"graphql-language-service-parser": "1.9.0"
},
...

  • a360f9478: Expose the catalog-import route as an external route from the scaffolder.

    This will make it possible to hide the "Register Existing Component" button
    when you for example are running backstage with catalog.readonly=true.

    As a consequence of this change you need add a new binding to your createApp call to
    keep the button visible. However, if you instead want to hide the button you can safely
    ignore the following example.

    To bind the external route from the catalog-import plugin to the scaffolder template
    index page, make sure you have the appropriate imports and add the following
    to the createApp call: 

    import { catalogImportPlugin } from '@backstage/plugin-catalog-import';


const app = createApp({
  // ...
  bindRoutes({ bind }) {
    // ...
    bind(scaffolderPlugin.externalRoutes, {
      registerComponent: catalogImportPlugin.routes.importPage,
    });
  },
});
    • f1952337c: Due to a change in the techdocs publishers, they don't check if they are able to reach e.g. the configured S3 bucket anymore.
      This can be added again by the following change. Note that the backend process will no longer exit when it is not reachable but will only emit an error log message.
      You should include the check when your backend to get early feedback about a potential misconfiguration:
      ```diff
      // packages/backend/src/plugins/techdocs.ts
      export default async function createPlugin({
      logger,
      config,
      discovery,
      reader,
      }: PluginEnvironment): Promise {
      // ...
      const publisher = await Publisher.fromConfig(config, {
      logger,
      discovery,
      })
    • // checks if the publisher is working and logs the result
    • await publisher.getReadiness();
      // Docker client (conditionally) used by the generators, based on techdocs.generators config.
      const dockerClient = new Docker();
      // ...
      }
      ```

  • Updated dependencies [d8ffec739]

  • Updated dependencies [7abec4dbc]

  • Updated dependencies [017192ee8]

  • Updated dependencies [a360f9478]

  • Updated dependencies [bb5055aee]

  • Updated dependencies [d840d30bc]

  • Updated dependencies [d0d1c2f7b]

  • Updated dependencies [5d0740563]

  • Updated dependencies [b25846562]

  • Updated dependencies [12390778e]

  • Updated dependencies [cba5944fc]

  • Updated dependencies [a376e3ee8]

  • Updated dependencies [fef852ecd]

  • Updated dependencies [18f7345a6]

  • Updated dependencies [5cafcf452]

  • Updated dependencies [423a514c3]

  • Updated dependencies [86a95ba67]

  • Updated dependencies [442f34b87]

  • Updated dependencies [e27cb6c45]

  • Updated dependencies [184b02bef]

  • Updated dependencies [0b7fd7a9d]

  • Updated dependencies [60ce64aa2]

    • @backstage/plugin-scaffolder-backend@0.9.6
    • @backstage/plugin-catalog-backend@0.7.1
    • @backstage/plugin-scaffolder@0.9.0
    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5
    • @backstage/plugin-catalog@0.5.4
    • @backstage/plugin-api-docs@0.4.11
    • @backstage/plugin-techdocs-backend@0.7.1
    • @backstage/plugin-techdocs@0.7.2
    • @backstage/catalog-client@0.3.10
    • @backstage/plugin-tech-radar@0.3.9
    • @backstage/cli@0.6.8

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

Patch Changes

  • 12390778e: chore(deps): bump @asyncapi/react-component from 0.19.2 to 0.22.3
  • 5cafcf452: add debounce time attribute for apis-docs for search, giving more time to the users when they are typing.
  • Updated dependencies [bb5055aee]
  • Updated dependencies [d0d1c2f7b]
  • Updated dependencies [5d0740563]
  • Updated dependencies [5cafcf452]
  • Updated dependencies [86a95ba67]
  • Updated dependencies [e27cb6c45]
    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5

## @backstage/plugin-catalog@0.5.4

Patch Changes

  • 5d0740563: Implemented missing support for the dependsOn/dependencyOf relationships
    between Component and Resource catalog model objects.

    Added support for generating the relevant relationships to the
    BuiltinKindsEntityProcessor, and added simple support for fetching
    relationships between Components and Resources for rendering in the
    system diagram. All catalog-model changes backwards compatible.

  • Updated dependencies [bb5055aee]

  • Updated dependencies [d0d1c2f7b]

  • Updated dependencies [5d0740563]

  • Updated dependencies [5cafcf452]

  • Updated dependencies [86a95ba67]

  • Updated dependencies [442f34b87]

  • Updated dependencies [e27cb6c45]

    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5
    • @backstage/catalog-client@0.3.10

## @backstage/plugin-catalog-backend@0.7.1

Patch Changes

  • 017192ee8: Add support for configure an LDAP query filter on multiple lines.

  • 5d0740563: Implemented missing support for the dependsOn/dependencyOf relationships
    between Component and Resource catalog model objects.

    Added support for generating the relevant relationships to the
    BuiltinKindsEntityProcessor, and added simple support for fetching
    relationships between Components and Resources for rendering in the
    system diagram. All catalog-model changes backwards compatible.

  • Updated dependencies [bb5055aee]

  • Updated dependencies [5d0740563]

    • @backstage/catalog-model@0.7.7

## @backstage/plugin-kubernetes-backend@0.3.4

Patch Changes

  • 7fd46f26d: Use string TypeScript type instead of String.
  • Updated dependencies [bb5055aee]
  • Updated dependencies [5d0740563]
    • @backstage/catalog-model@0.7.7

## @backstage/plugin-scaffolder-backend@0.9.6

Patch Changes

  • d8ffec739: Add built-in publish action for creating GitHub pull requests.

  • 7abec4dbc: Fix for the file:// protocol check in the FilePreparer being too strict, breaking Windows.

  • d840d30bc: Bitbucket server needs username to be set as well as the token or appPassword for the publishing process to work. 

    integrations:
  bitbucket:
    - host: bitbucket.mycompany.com
      apiBaseUrl: https://bitbucket.mycompany.com/rest/api/1.0
      token: token
      username: username
    • b25846562: Enable the JSON parsing of the response from templated variables in the v2beta1 syntax. Previously if template parameters json strings they were left as strings, they are now parsed as JSON objects.
      Before:
      ```yaml
    • id: test
      name: test-action
      action: custom:run
      input:
      input: '{"hello":"ben"}'
      Now: yaml
    • id: test
      name: test-action
      action: custom:run
      input:
      input:
      hello: ben
      Also added the `parseRepoUrl` and `json` helpers to the parameters syntax. You can now use these helpers to parse work with some `json` or `repoUrl` strings in templates. yaml
      - id: test
      name: test-action
      action: cookiecutter:fetch
      input:
      destination: '{{ parseRepoUrl parameters.repoUrl }}'
      ```

    Will produce a parsed version of the repoUrl of type { repo: string, owner: string, host: string } that you can use in your actions. Specifically cookiecutter with {{ cookiecutter.destination.owner }} like the plugins/scaffolder-backend/sample-templates/v1beta2-demo/template.yaml example.

  • a376e3ee8: Adds a collaborator field to GitHub publish action for multiple users and access levels

  • 423a514c3: Fix execution of the GitHub Pull Request publish action on Windows.

  • 0b7fd7a9d: Fix bug in pull request sample template.

  • Updated dependencies [bb5055aee]

  • Updated dependencies [5d0740563]

  • Updated dependencies [442f34b87]

    • @backstage/catalog-model@0.7.7
    • @backstage/catalog-client@0.3.10

## @backstage/plugin-sonarqube@0.1.16

Patch Changes

  • db802fafb: Export isSonarQubeAvailable.
  • Updated dependencies [bb5055aee]
  • Updated dependencies [d0d1c2f7b]
  • Updated dependencies [5d0740563]
  • Updated dependencies [5cafcf452]
  • Updated dependencies [86a95ba67]
  • Updated dependencies [e27cb6c45]
    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5

## @backstage/plugin-tech-radar@0.3.9

Patch Changes

  • 184b02bef: Add markdown support for tech radar entry description
  • Updated dependencies [d0d1c2f7b]
  • Updated dependencies [5cafcf452]
  • Updated dependencies [86a95ba67]
  • Updated dependencies [e27cb6c45]
    • @backstage/core@0.7.5

## @backstage/plugin-techdocs@0.7.2

Patch Changes

  • fef852ecd: Reworked the TechDocs plugin to support using the configured company name instead of
    'Backstage' in the page title.
  • 18f7345a6: Add borders to TechDocs tables and increase font size. Fixes #5264 and #5276.
  • Updated dependencies [bb5055aee]
  • Updated dependencies [d0d1c2f7b]
  • Updated dependencies [5d0740563]
  • Updated dependencies [5cafcf452]
  • Updated dependencies [86a95ba67]
  • Updated dependencies [e27cb6c45]
    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5

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

Patch Changes

  • cba5944fc: Change the response status of metadata endpoints in case a documentation is not
    available to 404 NOT FOUND. This also introduces the JSON based error messages
    used by other backends.
  • Updated dependencies [bc9d62f4f]
  • Updated dependencies [bb5055aee]
  • Updated dependencies [5d0740563]
    • @backstage/techdocs-common@0.5.0
    • @backstage/catalog-model@0.7.7

## example-app@0.2.24

Patch Changes

  • Updated dependencies [a360f9478]
  • Updated dependencies [bb5055aee]
  • Updated dependencies [d0d1c2f7b]
  • Updated dependencies [5d0740563]
  • Updated dependencies [12390778e]
  • Updated dependencies [fef852ecd]
  • Updated dependencies [18f7345a6]
  • Updated dependencies [5cafcf452]
  • Updated dependencies [86a95ba67]
  • Updated dependencies [e27cb6c45]
  • Updated dependencies [184b02bef]
  • Updated dependencies [60ce64aa2]
    • @backstage/plugin-scaffolder@0.9.0
    • @backstage/catalog-model@0.7.7
    • @backstage/core@0.7.5
    • @backstage/plugin-catalog@0.5.4
    • @backstage/plugin-api-docs@0.4.11
    • @backstage/plugin-techdocs@0.7.2
    • @backstage/plugin-tech-radar@0.3.9
    • @backstage/cli@0.6.8
Check out latest releases or
releases around backstage/backstage release-2021-04-15

Don't miss a new backstage release

NewReleases is sending notifications on new releases.

Get notifications