Object lists package

.github/workflows/database-merge-and-deploy-schema-changes.yml

@@ -0,0 +1,34 @@
+name: Merge and deploy database schema changes
+on:
+  pull_request:
+    branches: ["main"]
+    types: [closed]
+    paths: ["packages/database/migrations/**"]
+
+jobs:
+  merge_changes:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: Create a deploy request
+        uses: planetscale/create-deploy-request-action@v1
+        id: create_deploy_request
+        with:
+          org_name: colonial-collections
+          database_name: datahub
+          branch_name: development
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+      - name: Deploy a deploy request
+        uses: planetscale/deploy-deploy-request-action@v1
+        with:
+          org_name: colonial-collections
+          database_name: datahub
+          number: ${{ steps.create_deploy_request.outputs.number }}
+          wait: true
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}

.github/workflows/database-migrate.yml

@@ -0,0 +1,30 @@
+name: Migrate database
+
+on:
+  pull_request:
+    branches: ["main"]
+    paths: ["packages/database/migrations/**"]
+
+jobs:
+  migrate:
+    env:
+      DATABASE_URL: ${{ secrets.PLANETSCALE_DATABASE_URL }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+      - run: npm ci
+      - run: npm run db:migrate
+      - name: Add comment
+        uses: mshick/add-pr-comment@v2
+        with:
+          message: |
+            ## Database schema changes have been applied
+
+            The development database migrated with the migrations found in this branch. 
+
+            **Warning**: All preview and development environments use the same database. This migration can affect all preview and development environments.
+
+            After merging this pull request, the development database changes will merge into the production database.

README.md

@@ -68,6 +68,10 @@ Then run:
 
     docker run --rm -it -v "$PWD":/app -w /app node:18 /bin/bash
 
+### Connecting to the MySQL server
+
+Add `DATABASE_URL` environment variable to the file `apps/researcher/.env.local`. More information about connecting to the database is in the [database readme](packages/database/README.md).
+
 ### Install packages
 
     docker run --rm -it -v "$PWD":/app -w /app node:18 npm install --no-progress

apps/researcher/package.json

@@ -21,7 +21,7 @@
   },
   "dependencies": {
     "@clerk/localizations": "1.25.2",
-    "@clerk/nextjs": "4.21.13",
+    "@clerk/nextjs": "4.23.2",
     "@clerk/types": "3.51.0",
     "@colonial-collections/content": "*",
     "@colonial-collections/iris": "*",
@@ -35,6 +35,7 @@
     "fetch-sparql-endpoint": "3.3.3",
     "next": "13.4.7",
     "next-intl": "3.0.0-beta.7",
+    "@colonial-collections/database": "*",
     "openseadragon": "4.1.0",
     "rdf-object": "1.14.0",
     "react": "18.2.0",