@backstage/create-app 0.4.31-next.3 → 0.4.31

package/CHANGELOG.md

@@ -1,5 +1,197 @@
 # @backstage/create-app
 
+## 0.4.31
+
+### Patch Changes
+
+- 6ff94d60d5: Removed usage of the deprecated `diff` command in the root `package.json`.
+
+  To make this change in an existing app, make the following change in the root `package.json`:
+
+  ```diff
+  -    "diff": "lerna run diff --",
+  ```
+
+- c1f1a4c760: The Backstage packages and plugins have all been updated to support React Router v6 stable. The `create-app` template has not been migrated yet, but if you want to migrate your own app or plugins, check out the [migration guide](https://backstage.io/docs/tutorials/react-router-stable-migration).
+- e83de28e36: Fix typo in the documentation
+- 7d47def9c4: Removed dependency on `@types/jest`.
+- 208d6780c9: The `packages/backend/Dockerfile` received a couple of updates, it now looks as follows:
+
+  ```Dockerfile
+  FROM node:16-bullseye-slim
+
+  # Install sqlite3 dependencies. You can skip this if you don't use sqlite3 in the image,
+  # in which case you should also move better-sqlite3 to "devDependencies" in package.json.
+  RUN apt-get update && \
+      apt-get install -y --no-install-recommends libsqlite3-dev python3 build-essential && \
+      rm -rf /var/lib/apt/lists/* && \
+      yarn config set python /usr/bin/python3
+
+  # From here on we use the least-privileged `node` user to run the backend.
+  USER node
+  WORKDIR /app
+
+  # This switches many Node.js dependencies to production mode.
+  ENV NODE_ENV production
+
+  # Copy repo skeleton first, to avoid unnecessary docker cache invalidation.
+  # The skeleton contains the package.json of each package in the monorepo,
+  # and along with yarn.lock and the root package.json, that's enough to run yarn install.
+  COPY --chown=node:node yarn.lock package.json packages/backend/dist/skeleton.tar.gz ./
+  RUN tar xzf skeleton.tar.gz && rm skeleton.tar.gz
+
+  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.
+  COPY --chown=node:node packages/backend/dist/bundle.tar.gz app-config*.yaml ./
+  RUN tar xzf bundle.tar.gz && rm bundle.tar.gz
+
+  CMD ["node", "packages/backend", "--config", "app-config.yaml", "--config", "app-config.production.yaml"]
+  ```
+
+  The two notable changes are that a `USER node` instruction has been added and the ordering of instructions has been changed accordingly. This means that the app will now be running using the least-privileged `node` user. In order for this to work we now need to make sure that all app files are owned by the `node` user, which we do by adding the `--chown=node:node` option to the `COPY` instructions.
+
+  The second change is the addition of `ENV NODE_ENV production`, which ensured that all Node.js modules run in production mode. If you apply this change to an existing app, note that one of the more significant changes is that this switches the log formatting to use the default production format, JSON. Rather than your log lines looking like this:
+
+  ```log
+  2022-08-10T11:36:05.478Z catalog info Performing database migration type=plugin
+  ```
+
+  They will now look like this:
+
+  ```log
+  {"level":"info","message":"Performing database migration","plugin":"catalog","service":"backstage","type":"plugin"}
+  ```
+
+  If you wish to keep the existing format, you can override this change by applying the following change to `packages/backend/src/index.ts`:
+
+  ```diff
+     getRootLogger,
+  +  setRootLogger,
+  +  createRootLogger,
+  +  coloredFormat,
+     useHotMemoize,
+   ...
+     ServerTokenManager,
+   } from '@backstage/backend-common';
+
+   ...
+
+   async function main() {
+  +  setRootLogger(createRootLogger({ format: coloredFormat }));
+  +
+     const config = await loadBackendConfig({
+  ```
+
+- 49416194e8: Adds `IdentityApi` configuration to `create-app` scaffolding templates.
+
+  To migrate to the new `IdentityApi`, edit the `packages/backend/src/index.ts` adding the following import:
+
+  ```typescript
+  import { DefaultIdentityClient } from '@backstage/plugin-auth-node';
+  ```
+
+  Use the factory function to create an `IdentityApi` in the `makeCreateEnv` function and return it from the
+  function as follows:
+
+  ```typescript
+  function makeCreateEnv(config: Config) {
+  ...
+    const identity = DefaultIdentityClient.create({
+      discovery,
+    });
+  ...
+
+    return {
+      ...,
+      identity
+    }
+  }
+  ```
+
+  Backend plugins can be upgraded to work with this new `IdentityApi`.
+
+  Add `identity` to the `RouterOptions` type.
+
+  ```typescript
+  export interface RouterOptions {
+    ...
+    identity: IdentityApi;
+  }
+  ```
+
+  Then you can use the `IdentityApi` from the plugin.
+
+  ```typescript
+  export async function createRouter(
+    options: RouterOptions,
+  ): Promise<express.Router> {
+    const { identity } = options;
+
+    router.get('/user', async (req, res) => {
+      const user = await identity.getIdentity({ request: req });
+      ...
+  ```
+
+- 8d886dd33e: Added `yarn new` as one of the scripts installed by default, which calls `backstage-cli new`. This script replaces `create-plugin`, which you can now remove if you want to. It is kept in the `create-app` template for backwards compatibility.
+
+  The `remove-plugin` command has been removed, as it has been removed from the Backstage CLI.
+
+  To apply these changes to an existing app, make the following change to the root `package.json`:
+
+  ```diff
+  -    "remove-plugin": "backstage-cli remove-plugin"
+  +    "new": "backstage-cli new --scope internal"
+  ```
+
+- c3c90280be: The options part of `DatabaseManager.fromConfig` now accepts an optional logger
+  field. You may want to supply that logger in your backend initialization code to
+  ensure that you can get relevant logging data when things happen related to the
+  connection pool.
+
+  In `packages/backend/src/index.ts`:
+
+  ```diff
+   function makeCreateEnv(config: Config) {
+     const root = getRootLogger();
+     ...
+  -  const databaseManager = DatabaseManager.fromConfig(config);
+  +  const databaseManager = DatabaseManager.fromConfig(config, { logger: root });
+  ```
+
+- a578558180: Updated the root `package.json` to use the new `backstage-cli repo clean` command.
+
+  To apply this change to an existing project, make the following change to the root `package.json`:
+
+  ```diff
+  -    "clean": "backstage-cli clean && lerna run clean",
+  +    "clean": "backstage-cli repo clean",
+  ```
+
+- c0a08fd08c: Added `EntityLinksCard` to the system `EntityPage`.
+
+  For an existing installation where you want to display the links card for entity pages of kind `system` you should make the following adjustment to `packages/app/src/components/catalog/EntityPage.tsx`
+
+  ```diff
+  const systemPage = (
+    ...
+          <Grid item md={6} xs={12}>
+            <EntityCatalogGraphCard variant="gridItem" height={400} />
+          </Grid>
+  +       <Grid item md={4} xs={12}>
+  +         <EntityLinksCard />
+  +       </Grid>
+  -      <Grid item md={6}>
+  +      <Grid item md={8}>
+            <EntityHasComponentsCard variant="gridItem" />
+          </Grid>
+    ...
+  );
+  ```
+
+- Updated dependencies
+  - @backstage/cli-common@0.1.10
+
 ## 0.4.31-next.3
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -57,101 +57,101 @@ ${chalk__default["default"].red(`${error}`)}
   }
 }
 
-var version$L = "1.6.0-next.3";
+var version$L = "1.6.0";
 
-var version$K = "1.0.6-next.2";
+var version$K = "1.0.6";
 
-var version$J = "0.15.1-next.3";
+var version$J = "0.15.1";
 
-var version$I = "0.3.5-next.1";
+var version$I = "0.3.5";
 
-var version$H = "1.1.0-next.2";
+var version$H = "1.1.0";
 
-var version$G = "1.1.1-next.0";
+var version$G = "1.1.1";
 
-var version$F = "0.19.0-next.3";
+var version$F = "0.19.0";
 
-var version$E = "1.0.2-next.0";
+var version$E = "1.0.2";
 
-var version$D = "1.1.0-next.3";
+var version$D = "1.1.0";
 
-var version$C = "0.11.1-next.3";
+var version$C = "0.11.1";
 
-var version$B = "1.0.6-next.3";
+var version$B = "1.0.6";
 
-var version$A = "1.1.1-next.0";
+var version$A = "1.1.1";
 
-var version$z = "1.1.4-next.2";
+var version$z = "1.1.4";
 
-var version$y = "1.2.0-next.3";
+var version$y = "1.2.0";
 
 var version$x = "0.2.16";
 
-var version$w = "0.8.9-next.3";
+var version$w = "0.8.9";
 
-var version$v = "0.3.36-next.3";
+var version$v = "0.3.36";
 
-var version$u = "0.16.0-next.3";
+var version$u = "0.16.0";
 
-var version$t = "0.2.5-next.3";
+var version$t = "0.2.5";
 
-var version$s = "1.5.1-next.3";
+var version$s = "1.5.1";
 
-var version$r = "1.0.6-next.0";
+var version$r = "1.0.6";
 
-var version$q = "1.1.4-next.2";
+var version$q = "1.1.4";
 
-var version$p = "1.4.0-next.3";
+var version$p = "1.4.0";
 
-var version$o = "0.2.21-next.2";
+var version$o = "0.2.21";
 
-var version$n = "0.8.12-next.3";
+var version$n = "0.8.12";
 
-var version$m = "0.3.9-next.3";
+var version$m = "0.3.9";
 
-var version$l = "0.3.40-next.3";
+var version$l = "0.3.40";
 
-var version$k = "0.5.9-next.3";
+var version$k = "0.5.9";
 
-var version$j = "0.3.9-next.3";
+var version$j = "0.3.9";
 
-var version$i = "0.5.9-next.3";
+var version$i = "0.5.9";
 
-var version$h = "0.6.4-next.2";
+var version$h = "0.6.4";
 
-var version$g = "0.4.5-next.2";
+var version$g = "0.4.5";
 
-var version$f = "0.6.5-next.3";
+var version$f = "0.6.5";
 
-var version$e = "0.2.30-next.2";
+var version$e = "0.2.30";
 
-var version$d = "0.1.33-next.3";
+var version$d = "0.1.33";
 
-var version$c = "1.6.0-next.3";
+var version$c = "1.6.0";
 
-var version$b = "1.6.0-next.3";
+var version$b = "1.6.0";
 
-var version$a = "1.0.2-next.3";
+var version$a = "1.0.2";
 
-var version$9 = "1.1.0-next.2";
+var version$9 = "1.1.0";
 
-var version$8 = "1.0.2-next.1";
+var version$8 = "1.0.2";
 
-var version$7 = "0.4.0-next.2";
+var version$7 = "0.4.0";
 
-var version$6 = "1.0.2-next.2";
+var version$6 = "1.0.2";
 
-var version$5 = "0.5.16-next.3";
+var version$5 = "0.5.16";
 
-var version$4 = "1.3.2-next.3";
+var version$4 = "1.3.2";
 
-var version$3 = "1.0.4-next.2";
+var version$3 = "1.0.4";
 
-var version$2 = "1.0.4-next.2";
+var version$2 = "1.0.4";
 
-var version$1 = "1.3.0-next.2";
+var version$1 = "1.3.0";
 
-var version = "0.4.8-next.3";
+var version = "0.4.8";
 
 const packageVersions = {
   root: version$L,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/create-app",
   "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.4.31-next.3",
+  "version": "0.4.31",
   "publishConfig": {
     "access": "public"
   },
@@ -32,7 +32,7 @@
     "start": "nodemon --"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.10-next.0",
+    "@backstage/cli-common": "^0.1.10",
     "chalk": "^4.0.0",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
@@ -42,7 +42,7 @@
     "recursive-readdir": "^2.2.2"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.19.0-next.3",
+    "@backstage/cli": "^0.19.0",
     "@types/fs-extra": "^9.0.1",
     "@types/inquirer": "^8.1.3",
     "@types/node": "^16.11.26",
@@ -60,5 +60,5 @@
     "dist",
     "templates"
   ],
-  "gitHead": "2f458448f850dc68a711e2f31d14a91f96cf175d"
+  "gitHead": "25b94e63455f1fb170506f9e84e3f430f4b79406"
 }