Merge branch 'master' into mobile-sidebar

Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-12-28 18:39:03 +01:00
parent 545a26a0b6 26a0296341
commit 858b6e40c9
658 changed files with 11029 additions and 4156 deletions
@@ -1,5 +1,37 @@
 # @backstage/create-app

+## 0.4.9
+
+### Patch Changes
+
+- 49a696d720: debounceTime prop is removed from the SearchBar component in the SearchPage as the default is set to 200. The prop is safe to remove and makes it easier to stay up to date with any changes in the future.
+- 5fdc8df0e8: The `index.html` template of the app has been updated to use the new `config` global provided by the Backstage CLI.
+
+  To apply this change to an existing app, make the following changes to `packages/app/public/index.html`:
+
+  ```diff
+  -    <title><%= app.title %></title>
+  +    <title><%= config.getString('app.title') %></title>
+  ```
+
+  ```diff
+  -    <% if (app.googleAnalyticsTrackingId && typeof app.googleAnalyticsTrackingId === 'string') { %>
+  +    <% if (config.has('app.googleAnalyticsTrackingId')) { %>
+       <script
+         async
+  -      src="https://www.googletagmanager.com/gtag/js?id=<%= app.googleAnalyticsTrackingId %>"
+  +      src="https://www.googletagmanager.com/gtag/js?id=<%= config.getString('app.googleAnalyticsTrackingId') %>"
+       ></script>
+  ```
+
+  ```diff
+  -      gtag('config', '<%= app.googleAnalyticsTrackingId %>');
+  +      gtag(
+  +        'config',
+  +        '<%= config.getString("app.googleAnalyticsTrackingId") %>',
+  +      );
+  ```
+
 ## 0.4.8

 ### Patch Changes
@@ -1,7 +1,7 @@
 {
  "name": "@backstage/create-app",
  "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.4.8",
+  "version": "0.4.9",
  "private": false,
  "publishConfig": {
    "access": "public"
@@ -49,6 +49,7 @@
  },
  "peerDependencies": {
    "@backstage/backend-common": "*",
+    "@backstage/backend-tasks": "*",
    "@backstage/catalog-client": "*",
    "@backstage/catalog-model": "*",
    "@backstage/cli": "*",
@@ -32,6 +32,7 @@ leaving any imports in place.

 import { version as appDefaults } from '../../../app-defaults/package.json';
 import { version as backendCommon } from '../../../backend-common/package.json';
+import { version as backendTasks } from '../../../backend-tasks/package.json';
 import { version as catalogClient } from '../../../catalog-client/package.json';
 import { version as catalogModel } from '../../../catalog-model/package.json';
 import { version as cli } from '../../../cli/package.json';
@@ -71,6 +72,7 @@ import { version as pluginUserSettings } from '../../../../plugins/user-settings
 export const packageVersions = {
  '@backstage/app-defaults': appDefaults,
  '@backstage/backend-common': backendCommon,
+  '@backstage/backend-tasks': backendTasks,
  '@backstage/catalog-client': catalogClient,
  '@backstage/catalog-model': catalogModel,
  '@backstage/cli': cli,
@@ -42,17 +42,11 @@
      href="<%= publicPath %>/safari-pinned-tab.svg"
      color="#5bbad5"
    />
-    <style>
-      #root {
-        min-height: 100%;
-      }
-    </style>
-    <title><%= app.title %></title>
-    <% if (app.googleAnalyticsTrackingId && typeof app.googleAnalyticsTrackingId
-    === 'string') { %>
+    <title><%= config.getString('app.title') %></title>
+    <% if (config.has('app.googleAnalyticsTrackingId')) { %>
    <script
      async
-      src="https://www.googletagmanager.com/gtag/js?id=<%= app.googleAnalyticsTrackingId %>"
+      src="https://www.googletagmanager.com/gtag/js?id=<%= config.getString('app.googleAnalyticsTrackingId') %>"
    ></script>
    <script>
      window.dataLayer = window.dataLayer || [];
@@ -61,11 +55,14 @@
      }
      gtag('js', new Date());

-      gtag('config', '<%= app.googleAnalyticsTrackingId %>');
+      gtag(
+        'config',
+        '<%= config.getString("app.googleAnalyticsTrackingId") %>',
+      );
    </script>
    <% } %>
  </head>
-  <body style="margin: 0">
+  <body>
    <noscript>You need to enable JavaScript to run this app.</noscript>
    <div id="root"></div>
    <!--
@@ -37,7 +37,7 @@ const SearchPage = () => {
        <Grid container direction="row">
          <Grid item xs={12}>
            <Paper className={classes.bar}>
-              <SearchBar debounceTime={100} />
+              <SearchBar />
            </Paper>
          </Grid>
          <Grid item xs={3}>
@@ -16,6 +16,7 @@
  "dependencies": {
    "app": "0.0.0",
    "@backstage/backend-common": "^{{version '@backstage/backend-common'}}",
+    "@backstage/backend-tasks": "^{{version '@backstage/backend-tasks'}}",
    "@backstage/catalog-model": "^{{version '@backstage/catalog-model'}}",
    "@backstage/catalog-client": "^{{version '@backstage/catalog-client'}}",
    "@backstage/config": "^{{version '@backstage/config'}}",
@@ -19,6 +19,7 @@ import {
  UrlReaders,
  ServerTokenManager,
 } from '@backstage/backend-common';
+import { TaskScheduler } from '@backstage/backend-tasks';
 import { Config } from '@backstage/config';
 import app from './plugins/app';
 import auth from './plugins/auth';
@@ -33,18 +34,28 @@ function makeCreateEnv(config: Config) {
  const root = getRootLogger();
  const reader = UrlReaders.default({ logger: root, config });
  const discovery = SingleHostDiscovery.fromConfig(config);
-
-  root.info(`Created UrlReader ${reader}`);
-
  const cacheManager = CacheManager.fromConfig(config);
  const databaseManager = DatabaseManager.fromConfig(config);
  const tokenManager = ServerTokenManager.noop();
+  const taskScheduler = TaskScheduler.fromConfig(config);
+
+  root.info(`Created UrlReader ${reader}`);

  return (plugin: string): PluginEnvironment => {
    const logger = root.child({ type: 'plugin', plugin });
    const database = databaseManager.forPlugin(plugin);
    const cache = cacheManager.forPlugin(plugin);
-    return { logger, database, cache, config, reader, discovery, tokenManager };
+    const scheduler = taskScheduler.forPlugin(plugin);
+    return {
+      logger,
+      database,
+      cache,
+      config,
+      reader,
+      discovery,
+      tokenManager,
+      scheduler,
+    };
  };
 }

@@ -7,6 +7,7 @@ import {
  TokenManager,
  UrlReader,
 } from '@backstage/backend-common';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';

 export type PluginEnvironment = {
  logger: Logger;
@@ -16,4 +17,5 @@ export type PluginEnvironment = {
  reader: UrlReader;
  discovery: PluginEndpointDiscovery;
  tokenManager: TokenManager;
+  scheduler: PluginTaskScheduler;
 };