@backstage/create-app 0.4.19-next.0 → 0.4.21

package/CHANGELOG.md

@@ -1,5 +1,152 @@
 # @backstage/create-app
 
+## 0.4.21
+
+### Patch Changes
+
+- a686702dbe: Update the template to reflect the renaming of `CatalogResultListItem` to `CatalogSearchResultListItem` from `@backstage/plugin-catalog`.
+
+  To apply this change to an existing app, make the following change to `packages/app/src/components/search/SearchPage.tsx`:
+
+  ```diff
+  -import { CatalogResultListItem } from '@backstage/plugin-catalog';
+  +import { CatalogSearchResultListItem } from '@backstage/plugin-catalog';
+  ```
+
+  ```diff
+     case 'software-catalog':
+       return (
+  -      <CatalogResultListItem
+  +      <CatalogSearchResultListItem
+           key={document.location}
+           result={document}
+         />
+  ```
+
+- f39c1e6036: To reflect the updated `knex` and `@vscode/sqlite3` dependencies introduced with [v0.4.19](https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md#0419), we update our example `Dockerfile`, adding `@vscode/sqlite3` build dependencies to the image. Further on, we updated it to the `node:16-bullseye-slim` base image.
+
+  To apply this update to an existing app, make the following change to `packages/backend/Dockerfile`:
+
+  ```diff
+  -FROM node:14-buster-slim
+  +FROM node:16-bullseye-slim
+  ```
+
+  and, _only if you are using sqlite3 in your app_:
+
+  ```diff
+  RUN tar xzf skeleton.tar.gz && rm skeleton.tar.gz
+  +
+  +# install sqlite3 dependencies
+  +RUN apt-get update && \
+  +   apt-get install -y libsqlite3-dev python3 cmake g++ && \
+  +   rm -rf /var/lib/apt/lists/* && \
+  +   yarn config set python /usr/bin/python3
+
+  RUN yarn install --frozen-lockfile --production --network-timeout 300000 && rm -rf "$(yarn cache dir)"
+  ```
+
+  If you are using a multi-stage Docker build for your app, please refer to the [updated examples](https://github.com/backstage/backstage/blob/master/docs/deployment/docker.md#multi-stage-build) in the documentation.
+
+## 0.4.20
+
+### Patch Changes
+
+- e725bb812f: Remove SearchContextProvider from `<Root />`
+
+  The `SidebarSearchModal` exported from `plugin-search` internally renders `SearchContextProvider`, so it can be removed from `Root.tsx`:
+
+  ```diff
+  -import {
+  -  SidebarSearchModal,
+  -  SearchContextProvider,
+  -} from '@backstage/plugin-search';
+  +import { SidebarSearchModal } from '@backstage/plugin-search';
+
+  ... omitted ...
+
+         <SidebarGroup label="Search" icon={<SearchIcon />} to="/search">
+  -        <SearchContextProvider>
+  -          <SidebarSearchModal />
+  -        </SearchContextProvider>
+  +        <SidebarSearchModal />
+         </SidebarGroup>
+  ```
+
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- Updated dependencies
+  - @backstage/cli-common@0.1.7
+
+## 0.4.19
+
+### Patch Changes
+
+- 22f4ecb0e6: Switched the `file:` dependency for a `link:` dependency in the `backend` package. This makes sure that the `app` package is linked in rather than copied.
+
+  To apply this update to an existing app, make the following change to `packages/backend/package.json`:
+
+  ```diff
+     "dependencies": {
+  -    "app": "file:../app",
+  +    "app": "link:../app",
+       "@backstage/backend-common": "^{{version '@backstage/backend-common'}}",
+  ```
+
+- 1dd5a02e91: **BREAKING:** Updated `knex` to major version 1, which also implies changing out
+  the underlying `sqlite` implementation.
+
+  The old `sqlite3` NPM library has been abandoned by its maintainers, which has
+  led to unhandled security reports and other issues. Therefore, in the `knex` 1.x
+  release line they have instead switched over to the [`@vscode/sqlite3`
+  library](https://github.com/microsoft/vscode-node-sqlite3) by default, which is
+  actively maintained by Microsoft.
+
+  This means that as you update to this version of Backstage, there are two
+  breaking changes that you will have to address in your own repository:
+
+  ## Bumping `knex` itself
+
+  All `package.json` files of your repo that used to depend on a 0.x version of
+  `knex`, should now be updated to depend on the 1.x release line. This applies in
+  particular to `packages/backend`, but may also occur in backend plugins or
+  libraries.
+
+  ```diff
+  -    "knex": "^0.95.1",
+  +    "knex": "^1.0.2",
+  ```
+
+  Almost all existing database code will continue to function without modification
+  after this bump. The only significant difference that we discovered in the main
+  repo, is that the `alter()` function had a slightly different signature in
+  migration files. It now accepts an object with `alterType` and `alterNullable`
+  fields that clarify a previous grey area such that the intent of the alteration
+  is made explicit. This is caught by `tsc` and your editor if you are using the
+  `@ts-check` and `@param` syntax in your migration files
+  ([example](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend/migrations/20220116144621_remove_legacy.js#L17)),
+  which we strongly recommend.
+
+  See the [`knex` documentation](https://knexjs.org/#Schema-alter) for more
+  information about the `alter` syntax.
+
+  Also see the [`knex` changelog](https://knexjs.org/#changelog) for information
+  about breaking changes in the 1.x line; if you are using `RETURNING` you may
+  want to make some additional modifications in your code.
+
+  ## Switching out `sqlite3`
+
+  All `package.json` files of your repo that used to depend on `sqlite3`, should
+  now be updated to depend on `@vscode/sqlite3`. This applies in particular to
+  `packages/backend`, but may also occur in backend plugins or libraries.
+
+  ```diff
+  -    "sqlite3": "^5.0.1",
+  +    "@vscode/sqlite3": "^5.0.7",
+  ```
+
+  These should be functionally equivalent, except that the new library will have
+  addressed some long standing problems with old transitive dependencies etc.
+
 ## 0.4.19-next.0
 
 ### Patch Changes
@@ -271,11 +418,18 @@
   }
   ```
 
+The `.fromConfig` of the `DefaultCatalogCollator` also now takes a `tokenManager` as a parameter.
+
+```diff
+-   collator: DefaultCatalogCollator.fromConfig(config, { discovery }),
++   collator: DefaultCatalogCollator.fromConfig(config, { discovery, tokenManager }),
+```
+
 - a0d446c8ec: Replaced EntitySystemDiagramCard with EntityCatalogGraphCard
 
   To make this change to an existing app:
 
-  Add `@backstage/plugin-catalog-graph` as a `dependency` in `packages/app/package.json`
+  Add `@backstage/plugin-catalog-graph` as a `dependency` in `packages/app/package.json` or `cd packages/app && yarn add @backstage/plugin-catalog-graph`.
 
   Apply the following changes to the `packages/app/src/components/catalog/EntityPage.tsx` file:
 

package/dist/index.cjs.js

@@ -55,91 +55,91 @@ ${chalk__default["default"].red(`${error}`)}
   }
 }
 
-var version$G = "0.4.19-next.0";
+var version$G = "0.4.21";
 
-var version$F = "0.1.7-next.0";
+var version$F = "0.1.9";
 
-var version$E = "0.10.7-next.0";
+var version$E = "0.11.0";
 
-var version$D = "0.1.6-next.0";
+var version$D = "0.1.9";
 
-var version$C = "0.5.5";
+var version$C = "0.7.2";
 
-var version$B = "0.9.10";
+var version$B = "0.11.0";
 
-var version$A = "0.13.2-next.0";
+var version$A = "0.14.1";
 
-var version$z = "0.1.13";
+var version$z = "0.1.15";
 
-var version$y = "0.5.2";
+var version$y = "0.5.4";
 
-var version$x = "0.8.8-next.0";
+var version$x = "0.8.10";
 
-var version$w = "0.6.0";
+var version$w = "0.7.0";
 
-var version$v = "0.2.0";
+var version$v = "0.2.2";
 
-var version$u = "0.1.21-next.0";
+var version$u = "0.1.23";
 
-var version$t = "0.2.4";
+var version$t = "0.2.6";
 
-var version$s = "0.2.14";
+var version$s = "0.2.15";
 
-var version$r = "0.7.2-next.0";
+var version$r = "0.8.0";
 
-var version$q = "0.3.24-next.0";
+var version$q = "0.3.27";
 
-var version$p = "0.10.0-next.0";
+var version$p = "0.11.0";
 
-var version$o = "0.7.12-next.0";
+var version$o = "0.9.0";
 
-var version$n = "0.1.2";
+var version$n = "0.1.4";
 
-var version$m = "0.6.14-next.0";
+var version$m = "0.7.0";
 
-var version$l = "0.21.3-next.0";
+var version$l = "0.22.0";
 
-var version$k = "0.2.10-next.0";
+var version$k = "0.2.12";
 
-var version$j = "0.8.1-next.0";
+var version$j = "0.8.3";
 
-var version$i = "0.2.37-next.0";
+var version$i = "0.3.0";
 
-var version$h = "0.3.29-next.0";
+var version$h = "0.3.31";
 
-var version$g = "0.4.35-next.0";
+var version$g = "0.5.0";
 
-var version$f = "0.2.37-next.0";
+var version$f = "0.3.0";
 
-var version$e = "0.4.2-next.0";
+var version$e = "0.5.0";
 
-var version$d = "0.4.0";
+var version$d = "0.5.1";
 
-var version$c = "0.3.0";
+var version$c = "0.3.2";
 
-var version$b = "0.4.3-next.0";
+var version$b = "0.5.2";
 
-var version$a = "0.2.18-next.0";
+var version$a = "0.2.21";
 
-var version$9 = "0.1.21-next.0";
+var version$9 = "0.1.24";
 
-var version$8 = "0.12.2-next.0";
+var version$8 = "0.13.0";
 
-var version$7 = "0.15.24-next.0";
+var version$7 = "0.17.0";
 
-var version$6 = "0.6.2-next.0";
+var version$6 = "0.7.1";
 
-var version$5 = "0.4.2-next.0";
+var version$5 = "0.4.5";
 
-var version$4 = "0.4.5";
+var version$4 = "0.4.7";
 
-var version$3 = "0.5.5-next.0";
+var version$3 = "0.5.7";
 
-var version$2 = "0.13.3-next.0";
+var version$2 = "0.14.0";
 
-var version$1 = "0.13.3-next.0";
+var version$1 = "0.14.0";
 
-var version = "0.3.19-next.0";
+var version = "0.3.21";
 
 const packageVersions = {
   "@backstage/app-defaults": version$F,

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@backstage/create-app",
   "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.4.19-next.0",
+  "version": "0.4.21",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
+  "backstage": {
+    "role": "cli"
+  },
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
@@ -21,16 +24,16 @@
     "backstage-create-app": "bin/backstage-create-app"
   },
   "scripts": {
-    "build": "backstage-cli build --outputs cjs",
-    "lint": "backstage-cli lint",
-    "test": "backstage-cli test",
-    "clean": "backstage-cli clean",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
     "prepack": "node scripts/prepack.js",
     "postpack": "node scripts/postpack.js",
     "start": "nodemon --"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.6",
+    "@backstage/cli-common": "^0.1.8",
     "chalk": "^4.0.0",
     "commander": "^6.1.0",
     "fs-extra": "9.1.0",
@@ -57,5 +60,5 @@
     "dist",
     "templates"
   ],
-  "gitHead": "e6f167225d843beeb974c287c3364d951b587626"
+  "gitHead": "a15da6ea1e3e8adc37be98be064071c8b5279b4a"
 }

package/templates/default-app/packages/app/src/components/Root/Root.tsx

@@ -28,10 +28,7 @@ import {
   Settings as SidebarSettings,
   UserSettingsSignInAvatar,
 } from '@backstage/plugin-user-settings';
-import {
-  SidebarSearchModal,
-  SearchContextProvider,
-} from '@backstage/plugin-search';
+import { SidebarSearchModal } from '@backstage/plugin-search';
 import {
   Sidebar,
   sidebarConfig,
@@ -84,9 +81,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
     <Sidebar>
       <SidebarLogo />
       <SidebarGroup label="Search" icon={<SearchIcon />} to="/search">
-        <SearchContextProvider>
-          <SidebarSearchModal />
-        </SearchContextProvider>{' '}
+        <SidebarSearchModal />
       </SidebarGroup>
       <SidebarDivider />
       <SidebarGroup label="Menu" icon={<MenuIcon />}>

package/templates/default-app/packages/app/src/components/search/SearchPage.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import { makeStyles, Theme, Grid, List, Paper } from '@material-ui/core';
 
-import { CatalogResultListItem } from '@backstage/plugin-catalog';
+import { CatalogSearchResultListItem } from '@backstage/plugin-catalog';
 import {
   catalogApiRef,
   CATALOG_FILTER_EXISTS,
@@ -116,7 +116,7 @@ const SearchPage = () => {
                     switch (type) {
                       case 'software-catalog':
                         return (
-                          <CatalogResultListItem
+                          <CatalogSearchResultListItem
                             key={document.location}
                             result={document}
                           />

package/templates/default-app/packages/backend/Dockerfile

@@ -9,7 +9,7 @@
 #
 # Once the commands have been run, you can build the image using `yarn build-image`
 
-FROM node:14-buster-slim
+FROM node:16-bullseye-slim
 
 WORKDIR /app
 
@@ -19,6 +19,12 @@ WORKDIR /app
 COPY yarn.lock package.json packages/backend/dist/skeleton.tar.gz ./
 RUN tar xzf skeleton.tar.gz && rm skeleton.tar.gz
 
+# install sqlite3 dependencies
+RUN apt-get update && \
+    apt-get install -y libsqlite3-dev python3 cmake g++ && \
+    rm -rf /var/lib/apt/lists/* && \
+    yarn config set python /usr/bin/python3
+
 RUN yarn install --frozen-lockfile --production --network-timeout 300000 && rm -rf "$(yarn cache dir)"
 
 # Then copy the rest of the backend bundle, along with any other files we might want.