From 187e249276e90c43128789018f1256677241d63d Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 10 Aug 2022 12:48:19 +0200 Subject: [PATCH 1/2] create-app: switch better-sqlite3 to be prod dependency by default Signed-off-by: Patrik Oldsberg --- docs/deployment/docker.md | 6 ++++-- packages/backend/Dockerfile | 3 ++- .../templates/default-app/packages/backend/Dockerfile | 3 ++- .../templates/default-app/packages/backend/package.json.hbs | 4 ++-- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md index 6471ada7f2..6e0ff77228 100644 --- a/docs/deployment/docker.md +++ b/docs/deployment/docker.md @@ -60,7 +60,8 @@ FROM node:16-bullseye-slim WORKDIR /app -# install sqlite3 dependencies, you can skip this if you don't use sqlite3 in the image +# 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/* && \ @@ -178,7 +179,8 @@ FROM node:16-bullseye-slim WORKDIR /app -# install sqlite3 dependencies, you can skip this if you don't use sqlite3 in the image +# 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/* && \ diff --git a/packages/backend/Dockerfile b/packages/backend/Dockerfile index 86f6e17861..fb60b8a669 100644 --- a/packages/backend/Dockerfile +++ b/packages/backend/Dockerfile @@ -13,7 +13,8 @@ FROM node:16-bullseye-slim WORKDIR /app -# install sqlite3 dependencies, you can skip this if you don't use sqlite3 in the image +# 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/* && \ diff --git a/packages/create-app/templates/default-app/packages/backend/Dockerfile b/packages/create-app/templates/default-app/packages/backend/Dockerfile index a5773aa0f8..8836ac7898 100644 --- a/packages/create-app/templates/default-app/packages/backend/Dockerfile +++ b/packages/create-app/templates/default-app/packages/backend/Dockerfile @@ -13,7 +13,8 @@ FROM node:16-bullseye-slim WORKDIR /app -# install sqlite3 dependencies, you can skip this if you don't use sqlite3 in the image +# 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/* && \ diff --git a/packages/create-app/templates/default-app/packages/backend/package.json.hbs b/packages/create-app/templates/default-app/packages/backend/package.json.hbs index 3bd070ee9b..3853911c7f 100644 --- a/packages/create-app/templates/default-app/packages/backend/package.json.hbs +++ b/packages/create-app/templates/default-app/packages/backend/package.json.hbs @@ -33,6 +33,7 @@ "@backstage/plugin-search-backend-module-pg": "^{{version '@backstage/plugin-search-backend-module-pg'}}", "@backstage/plugin-search-backend-node": "^{{version '@backstage/plugin-search-backend-node'}}", "@backstage/plugin-techdocs-backend": "^{{version '@backstage/plugin-techdocs-backend'}}", + "better-sqlite3": "^7.5.0", "dockerode": "^3.3.1", "express": "^4.17.1", "express-promise-router": "^4.1.0", @@ -44,8 +45,7 @@ "@types/dockerode": "^3.3.0", "@types/express-serve-static-core": "^4.17.5", "@types/express": "^4.17.6", - "@types/luxon": "^2.0.4", - "better-sqlite3": "^7.5.0" + "@types/luxon": "^2.0.4" }, "files": [ "dist" From db76fc6255309365ead6c6527e4baffa7a9adb7b Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 10 Aug 2022 14:47:13 +0200 Subject: [PATCH 2/2] changesets: added changeset for better-sqlite3 move Signed-off-by: Patrik Oldsberg --- .changeset/loud-ears-taste.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/loud-ears-taste.md diff --git a/.changeset/loud-ears-taste.md b/.changeset/loud-ears-taste.md new file mode 100644 index 0000000000..479e14ce02 --- /dev/null +++ b/.changeset/loud-ears-taste.md @@ -0,0 +1,5 @@ +--- +'@backstage/create-app': patch +--- + +The `better-sqlite3` dependency has been moved back to production `"dependencies"` in `packages/backend/package.json`, with instructions in the Dockerfile to move it to `"devDependencies"` if desired. There is no need to apply this change to existing apps, unless you want your production image to have SQLite available as a database option.