Merge pull request #4 from secure-dashboards/feat/add-schemas

Author: UlisesGascon

.github/workflows/check-migrations.yml

@@ -0,0 +1,39 @@
+name: Check Migrations
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths:
+      - 'src/database/migrations/**'
+
+jobs:
+  check-migrations:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check and add comment to PR
+        uses: actions/github-script@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+
+            const commentExists = comments.some(comment =>
+              comment.body.includes("It looks like you've made changes to the migrations.")
+            );
+
+            if (!commentExists) {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body: "It looks like you've made changes to the migrations. Have you run `npm run db:generate-schema` to ensure the updated schemas are included in your PR?"
+              });
+            }

README.md

@@ -54,6 +54,18 @@ To seed the database with initial data, use the following command:
 npm run db:seed
 ```
 
+### Examine the database schema
+
+You can find an updated version of the schemas in [/src/database/schema/schema.sql](src/database/schema/schema.sql) so you don't have to start the infra and run the migrations if you just want to know about the database structure.
+
+### Update the database schema
+
+To update the schema, use the following command:
+
+```bash
+npm run db:generate-schema
+```
+
 ## Linting
 
 To lint the files, use the following command:

docker-compose.yml

@@ -19,5 +19,24 @@ services:
     ports:
       - 8080:8080
 
+  schema-dump:
+    image: postgres:17.2
+    depends_on:
+      - db
+    environment:
+      POSTGRES_DB: dashboard
+      POSTGRES_USER: openjs
+      POSTGRES_PASSWORD: password
+      PGPASSWORD: password  # bypass the password prompt
+    volumes:
+      - openjs_dashboard_data:/var/lib/postgresql/data
+      - ./src/database/schema:/schema
+    entrypoint: >
+      bash -c "
+      pg_dump --host=db --username=openjs --schema-only --no-owner --dbname=dashboard > /schema/schema.sql &&
+      chmod 644 /schema/schema.sql
+      "
+
+
 volumes:
   openjs_dashboard_data:

package.json

@@ -12,6 +12,7 @@
     "infra:stop": "docker-compose down",
     "db:migrate": "knex migrate:latest",
     "db:rollback": "knex migrate:rollback",
+    "db:generate-schema": "docker-compose run schema-dump",
     "db:seed": "knex seed:run"
   },
   "keywords": [],