chore: deprecate HASS add-on for game-db-updater

BREAKING CHANGE: game-db-updater is deprecated and removed. For this reason, the HASS add-on for game-db-updater is also removed. Playnite Web now includes the game-db-updater in one application.
andrew-codes · Jul 10, 2024 · 964eb9b · 964eb9b
1 parent 95b0f98
commit 964eb9b
Show file tree

Hide file tree

Showing 15 changed files with 7 additions and 256 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/README.md b/README.md
@@ -36,14 +36,12 @@ Playnite-Web consists the following:
 
 > All components are required.
 
-| Component           | Deployment Mechanism              | Purpose                                                                                                                                              |
-| :------------------ | :-------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
-| database            | Docker image / bring your own     | Mongo DB database that stores game data in `games` database.                                                                                         |
-| MQTT broker         | Docker image / bring your own     | Provides a communication mechanism between Playnite and Playnite-Web.                                                                                |
-| Playnite-Web Plugin | Extension installed into Playnite | The plugin sends and receives messages via MQTT when data in Playnite is changed.                                                                    |
-| Playnite-Web App    | Docker image                      | Web application and UI to browse and view game library. Updates database from Playnite-Web Plugin. Can be exposed to Internet to share with friends. |
-
-> Note, if you want to update your game library only, and not run Playnite-Web, you may do so by running the `playnite-web-game-db-updater`. However, do not run both this and Playnite-Web App. See the [playnite-web-game-db-updater documentation](docs/install/playnite-web-game-db-updater.md) for more details.
+| Component           | Deployment Mechanism              | Purpose                                                                                                        |
+| :------------------ | :-------------------------------- | :------------------------------------------------------------------------------------------------------------- |
+| (game) database     | Docker image / bring your own     | Mongo DB database that stores game data in `games` database.                                                   |
+| MQTT broker         | Docker image / bring your own     | Provides a communication mechanism between Playnite and Playnite-Web.                                          |
+| Playnite-Web Plugin | Extension installed into Playnite | The plugin sends and receives messages via MQTT when data in Playnite is changed.                              |
+| Playnite-Web App    | Docker image                      | Syncs Playnite games to game database, web UI, and GraphQL API that may be used to power your own experiences. |
 
 ### Deployment
 

diff --git a/docs/contributing/development-environment.md b/docs/contributing/development-environment.md
@@ -52,7 +52,7 @@ Install the following software on your local development machine:
 
 | Application      | Command                                                      | Notes                                                                                                                                                                                                      |
 | :--------------- | :----------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Playnite-Web App | `yarn nx run playnite-web-app:start`                         | Run Playnite-Web application locally. Navigate to [http://localhost:3000](http://localhost:3000) in a browser. Environment variables are pulled from `./apps/game-db-updater/local.env`.                   |
+| Playnite-Web App | `yarn nx run playnite-web-app:start`                         | Run Playnite-Web application locally. Navigate to [http://localhost:3000](http://localhost:3000) in a browser. Environment variables are pulled from `./apps/playnite-web/local.env`.                      |
 | Playnite-Web App | `yarn nx run playnite-web-app:test/components`               | Run component tests for development.                                                                                                                                                                       |
 | Playnite-Web App | `yarn nx run playnite-web-app:test/components/visual`        | Run visual regression component tests for development.                                                                                                                                                     |
 | Playnite-Web App | `yarn nx run playnite-web-app:test/components/visual/update` | Run visual regression tests with intention to update a baseline screenshot.                                                                                                                                |

diff --git a/docs/install/playnite-web-game-db-updater.md b/docs/install/playnite-web-game-db-updater.md
diff --git a/hass-game-db-updater/Dockerfile b/hass-game-db-updater/Dockerfile
diff --git a/hass-game-db-updater/config.json b/hass-game-db-updater/config.json
diff --git a/hass-game-db-updater/icon.png b/hass-game-db-updater/icon.png
diff --git a/hass-game-db-updater/package.json b/hass-game-db-updater/package.json
diff --git a/hass-game-db-updater/project.json b/hass-game-db-updater/project.json
diff --git a/hass-game-db-updater/scripts/package.ts b/hass-game-db-updater/scripts/package.ts
diff --git a/hass-game-db-updater/scripts/publish.ts b/hass-game-db-updater/scripts/publish.ts
diff --git a/hass-game-db-updater/scripts/version.ts b/hass-game-db-updater/scripts/version.ts
diff --git a/hass-game-db-updater/src/run.sh b/hass-game-db-updater/src/run.sh
diff --git a/yarn.lock b/yarn.lock
@@ -18397,22 +18397,6 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"playnite-web-game-db-updater-hass-addon@workspace:hass-game-db-updater":
-  version: 0.0.0-use.local
-  resolution: "playnite-web-game-db-updater-hass-addon@workspace:hass-game-db-updater"
-  dependencies:
-    "@types/lodash": "npm:^4.17.6"
-    "@types/shelljs": "npm:^0.8.15"
-    esbuild: "npm:^0.21.5"
-    esbuild-register: "npm:^3.5.0"
-    lodash: "npm:^4.17.21"
-    nx: "npm:^19.3.2"
-    playnite-web-game-db-updater: "workspace:*"
-    shelljs: "npm:^0.8.5"
-    versioning: "workspace:*"
-  languageName: unknown
-  linkType: soft
-
 "playnite-web-game-db-updater@workspace:*, playnite-web-game-db-updater@workspace:apps/game-db-updater":
   version: 0.0.0-use.local
   resolution: "playnite-web-game-db-updater@workspace:apps/game-db-updater"