Merge branch 'develop' into feat/add-structured-data

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,89 @@
+name: "🐛 Bug Report"
+title: "🐛 [BUG] - <title>"
+description: "Create a report to help us improve MUSCLE"
+assignees: []
+labels: [
+  "bug"
+]
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: "Description"
+    description: Please enter an explicit description of your issue
+    placeholder: | 
+      Short and explicit description of your incident... 
+
+      ## Screenshots:
+      Please also post any screenshots of the bug you encountered
+    value: |
+      <!-- Short and explicit description of your incident... -->
+
+      ### Screenshots
+      <!-- You can upload screenshots of the issue (if any) here... -->
+      
+  validations:
+    required: true
+- type: input
+  id: reprod-url
+  attributes:
+    label: "Reproduction URL"
+    description: Please enter your the URL to provide a reproduction of the issue
+    placeholder: ex. http://acc.amsterdammusiclab.nl/tunetwins
+  validations:
+    required: false
+- type: textarea
+  id: reprod
+  attributes:
+    label: "Reproduction steps"
+    description: Please enter an explicit description of your issue
+    value: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+    render: bash
+  validations:
+    required: true
+- type: textarea
+  id: logs
+  attributes:
+    label: "Logs"
+    description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+    render: bash
+  validations:
+    required: false
+- type: dropdown
+  id: browsers
+  attributes:
+    label: "Browsers"
+    description: What browsers are you seeing the problem on?
+    multiple: true
+    options:
+      - Firefox
+      - Chrome
+      - Safari
+      - Microsoft Edge
+      - Opera
+  validations:
+    required: false
+- type: dropdown
+  id: os
+  attributes:
+    label: "OS"
+    description: What is the impacted environment ?
+    multiple: true
+    options:
+      - Windows
+      - Linux
+      - Mac
+  validations:
+    required: false
+- type: textarea
+  id: context
+  attributes:
+    label: "Additional context"
+    description: Add any other context about the problem here.
+    placeholder: 
+  validations:
+    required: false

.github/workflows/podman.yml

@@ -5,14 +5,20 @@ on:
     branches:
       - develop
       - main
+    tags:
+      - '*'
   workflow_dispatch:
+  release:
+    types: [created]
 
 jobs:
   deploy-test:
     name: Deploy to test environment
     environment: Test
     runs-on: tst
-    if: github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/develop'
+
+    # this job runs only on commits to the develop branch or when manually triggered for a branch other than main
+    if: github.ref == 'refs/heads/develop' || (github.event_name == 'workflow_dispatch' && github.ref != 'refs/heads/main')
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     env:
@@ -24,13 +30,21 @@ jobs:
       AML_LOCATION_PROVIDER: ${{ vars.AML_LOCATION_PROVIDER }}
       AML_SUBPATH: ${{ vars.AML_SUBPATH }}
       DJANGO_SETTINGS_MODULE: ${{ vars.DJANGO_SETTINGS_MODULE }}
+      SENTRY_ENVIRONMENT: "test"
       SQL_DATABASE: ${{ vars.SQL_DATABASE }}
       SQL_HOST: ${{ vars.SQL_HOST }}
       SQL_PORT: ${{ vars.SQL_PORT }}
       FRONTEND_API_ROOT: ${{ vars.FRONTEND_API_ROOT }}
       FRONTEND_EXPERIMENT_SLUG: ${{ vars.FRONTEND_EXPERIMENT_SLUG }}
       FRONTEND_AML_HOME: ${{ vars.FRONTEND_AML_HOME }}
       FRONTEND_HTML_PAGE_TITLE: ${{ vars.FRONTEND_HTML_PAGE_TITLE }}
+      FRONTEND_HTML_FAVICON: ${{ vars.FRONTEND_HTML_FAVICON || '' }}
+      FRONTEND_LOGO_URL: ${{ vars.FRONTEND_LOGO_URL || '' }}
+      FRONTEND_HTML_OG_DESCRIPTION: ${{ vars.FRONTEND_HTML_OG_DESCRIPTION || '' }}
+      FRONTEND_HTML_OG_IMAGE: ${{ vars.FRONTEND_HTML_OG_IMAGE || '' }}
+      FRONTEND_HTML_OG_TITLE: ${{ vars.FRONTEND_HTML_OG_TITLE || '' }}
+      FRONTEND_HTML_OG_URL: ${{ vars.FRONTEND_HTML_OG_URL || '' }}
+      FRONTEND_HTML_BODY_CLASS: ${{ vars.FRONTEND_HTML_BODY_CLASS || '' }}
 
       # Secrets
       AML_SECRET_KEY: ${{ secrets.AML_SECRET_KEY }}
@@ -50,11 +64,18 @@ jobs:
       - name: Create .env file
         run: |
           touch .env
-          echo "FRONTEND_API_ROOT=$FRONTEND_API_ROOT" >> .env
-          echo "FRONTEND_EXPERIMENT_SLUG=$FRONTEND_EXPERIMENT_SLUG" >> .env
-          echo "FRONTEND_AML_HOME=$FRONTEND_AML_HOME" >> .env
-          echo "FRONTEND_HTML_PAGE_TITLE=$FRONTEND_HTML_PAGE_TITLE" >> .env
-          echo "FRONTEND_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
+          echo "VITE_API_ROOT=$FRONTEND_API_ROOT" >> .env
+          echo "VITE_EXPERIMENT_SLUG=$FRONTEND_EXPERIMENT_SLUG" >> .env
+          echo "VITE_AML_HOME=$FRONTEND_AML_HOME" >> .env
+          echo "VITE_LOGO_URL=$FRONTEND_LOGO_URL" >> .env
+          echo "VITE_HTML_FAVICON=$FRONTEND_HTML_FAVICON" >> .env
+          echo "VITE_HTML_PAGE_TITLE=$FRONTEND_HTML_PAGE_TITLE" >> .env
+          echo "VITE_HTML_OG_DESCRIPTION=$FRONTEND_HTML_OG_DESCRIPTION" >> .env
+          echo "VITE_HTML_OG_IMAGE=$FRONTEND_HTML_OG_IMAGE" >> .env
+          echo "VITE_HTML_OG_TITLE=$FRONTEND_HTML_OG_TITLE" >> .env
+          echo "VITE_HTML_OG_URL=$FRONTEND_HTML_OG_URL" >> .env
+          echo "VITE_HTML_BODY_CLASS=$FRONTEND_HTML_BODY_CLASS" >> .env
+          echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
           cp .env frontend/.env
       - name: Build Podman images
         run: podman-compose -f docker-compose-deploy.yml build
@@ -85,7 +106,9 @@ jobs:
     name: Deploy to acceptance environment
     environment: Acceptance
     runs-on: ACC
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/tags/*'
+
+    # this job runs only on commits to the main branch, tags, or when manually triggered for the main branch
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/tags/*' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     env:
@@ -97,13 +120,21 @@ jobs:
         AML_LOCATION_PROVIDER: ${{ vars.AML_LOCATION_PROVIDER }}
         AML_SUBPATH: ${{ vars.AML_SUBPATH }}
         DJANGO_SETTINGS_MODULE: ${{ vars.DJANGO_SETTINGS_MODULE }}
+        SENTRY_ENVIRONMENT: "acceptance"
         SQL_DATABASE: ${{ vars.SQL_DATABASE }}
         SQL_HOST: ${{ vars.SQL_HOST }}
         SQL_PORT: ${{ vars.SQL_PORT }}
         FRONTEND_API_ROOT: ${{ vars.FRONTEND_API_ROOT }}
         FRONTEND_EXPERIMENT_SLUG: ${{ vars.FRONTEND_EXPERIMENT_SLUG }}
         FRONTEND_AML_HOME: ${{ vars.FRONTEND_AML_HOME }}
         FRONTEND_HTML_PAGE_TITLE: ${{ vars.FRONTEND_HTML_PAGE_TITLE }}
+        FRONTEND_HTML_FAVICON: ${{ vars.FRONTEND_HTML_FAVICON || '' }}
+        FRONTEND_LOGO_URL: ${{ vars.FRONTEND_LOGO_URL || '' }}
+        FRONTEND_HTML_OG_DESCRIPTION: ${{ vars.FRONTEND_HTML_OG_DESCRIPTION || '' }}
+        FRONTEND_HTML_OG_IMAGE: ${{ vars.FRONTEND_HTML_OG_IMAGE || '' }}
+        FRONTEND_HTML_OG_TITLE: ${{ vars.FRONTEND_HTML_OG_TITLE || '' }}
+        FRONTEND_HTML_OG_URL: ${{ vars.FRONTEND_HTML_OG_URL || '' }}
+        FRONTEND_HTML_BODY_CLASS: ${{ vars.FRONTEND_HTML_BODY_CLASS || '' }}
 
         # Secrets
         AML_SECRET_KEY: ${{ secrets.AML_SECRET_KEY }}
@@ -123,11 +154,18 @@ jobs:
       - name: Create .env file
         run: |
           touch .env
-          echo "FRONTEND_API_ROOT=$FRONTEND_API_ROOT" >> .env
-          echo "FRONTEND_EXPERIMENT_SLUG=$FRONTEND_EXPERIMENT_SLUG" >> .env
-          echo "FRONTEND_AML_HOME=$FRONTEND_AML_HOME" >> .env
-          echo "FRONTEND_HTML_PAGE_TITLE=$FRONTEND_HTML_PAGE_TITLE" >> .env
-          echo "FRONTEND_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
+          echo "VITE_API_ROOT=$FRONTEND_API_ROOT" >> .env
+          echo "VITE_EXPERIMENT_SLUG=$FRONTEND_EXPERIMENT_SLUG" >> .env
+          echo "VITE_AML_HOME=$FRONTEND_AML_HOME" >> .env
+          echo "VITE_LOGO_URL=$FRONTEND_LOGO_URL" >> .env
+          echo "VITE_HTML_FAVICON=$FRONTEND_HTML_FAVICON" >> .env
+          echo "VITE_HTML_PAGE_TITLE=$FRONTEND_HTML_PAGE_TITLE" >> .env
+          echo "VITE_HTML_OG_DESCRIPTION=$FRONTEND_HTML_OG_DESCRIPTION" >> .env
+          echo "VITE_HTML_OG_IMAGE=$FRONTEND_HTML_OG_IMAGE" >> .env
+          echo "VITE_HTML_OG_TITLE=$FRONTEND_HTML_OG_TITLE" >> .env
+          echo "VITE_HTML_OG_URL=$FRONTEND_HTML_OG_URL" >> .env
+          echo "VITE_HTML_BODY_CLASS=$FRONTEND_HTML_BODY_CLASS" >> .env
+          echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
           cp .env frontend/.env
       - name: Build Podman images
         run: podman-compose -f docker-compose-deploy.yml build
@@ -154,3 +192,87 @@ jobs:
       - name: Check logs
         run: podman-compose -f docker-compose-deploy.yml logs
 
+  deploy-production:
+    name: Deploy to production environment
+    environment: Production
+    runs-on: PRD
+
+    # this job runs only on tags or when a release is created, or when manually triggered for a tag
+    if: github.ref == 'refs/tags/*' || github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/tags/*')
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    env:
+      # Variables
+      AML_ALLOWED_HOSTS: ${{ vars.AML_ALLOWED_HOSTS }}
+      AML_CORS_ORIGIN_WHITELIST: ${{ vars.AML_CORS_ORIGIN_WHITELIST }}
+      AML_DEBUG: ${{ vars.AML_DEBUG }}
+      AML_LOCATION_PROVIDER: ${{ vars.AML_LOCATION_PROVIDER }}
+      AML_SUBPATH: ${{ vars.AML_SUBPATH }}
+      DJANGO_SETTINGS_MODULE: ${{ vars.DJANGO_SETTINGS_MODULE }}
+      SENTRY_ENVIRONMENT: "acceptance"
+      SQL_DATABASE: ${{ vars.SQL_DATABASE }}
+      SQL_HOST: ${{ vars.SQL_HOST }}
+      SQL_PORT: ${{ vars.SQL_PORT }}
+      FRONTEND_API_ROOT: ${{ vars.FRONTEND_API_ROOT }}
+      FRONTEND_EXPERIMENT_SLUG: ${{ vars.FRONTEND_EXPERIMENT_SLUG }}
+      FRONTEND_AML_HOME: ${{ vars.FRONTEND_AML_HOME }}
+      FRONTEND_HTML_PAGE_TITLE: ${{ vars.FRONTEND_HTML_PAGE_TITLE }}
+      FRONTEND_HTML_FAVICON: ${{ vars.FRONTEND_HTML_FAVICON || '' }}
+      FRONTEND_LOGO_URL: ${{ vars.FRONTEND_LOGO_URL || '' }}
+      FRONTEND_HTML_OG_DESCRIPTION: ${{ vars.FRONTEND_HTML_OG_DESCRIPTION || '' }}
+      FRONTEND_HTML_OG_IMAGE: ${{ vars.FRONTEND_HTML_OG_IMAGE || '' }}
+      FRONTEND_HTML_OG_TITLE: ${{ vars.FRONTEND_HTML_OG_TITLE || '' }}
+      FRONTEND_HTML_OG_URL: ${{ vars.FRONTEND_HTML_OG_URL || '' }}
+      FRONTEND_HTML_BODY_CLASS: ${{ vars.FRONTEND_HTML_BODY_CLASS || '' }}
+
+      # Secrets
+      AML_SECRET_KEY: ${{ secrets.AML_SECRET_KEY }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+      SQL_USER: ${{ secrets.SQL_USER }}
+      SQL_PASSWORD: ${{ secrets.SQL_PASSWORD }}
+      FRONTEND_SENTRY_DSN: ${{ secrets.FRONTEND_SENTRY_DSN }}
+      DJANGO_SUPERUSER_USERNAME: ${{ secrets.DJANGO_SUPERUSER_USERNAME }}
+      DJANGO_SUPERUSER_PASSWORD: ${{ secrets.DJANGO_SUPERUSER_PASSWORD }}
+      DJANGO_SUPERUSER_EMAIL: ${{ secrets.DJANGO_SUPERUSER_EMAIL }}
+      # Prevent podman services from exiting after startup
+      RUNNER_TRACKING_ID: ""
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create .env file
+        run: |
+          touch .env
+          echo "VITE_API_ROOT=$FRONTEND_API_ROOT" >> .env
+          echo "VITE_EXPERIMENT_SLUG=$FRONTEND_EXPERIMENT_SLUG" >> .env
+          echo "VITE_AML_HOME=$FRONTEND_AML_HOME" >> .env
+          echo "VITE_LOGO_URL=$FRONTEND_LOGO_URL" >> .env
+          echo "VITE_HTML_FAVICON=$FRONTEND_HTML_FAVICON" >> .env
+          echo "VITE_HTML_PAGE_TITLE=$FRONTEND_HTML_PAGE_TITLE" >> .env
+          echo "VITE_HTML_OG_DESCRIPTION=$FRONTEND_HTML_OG_DESCRIPTION" >> .env
+          echo "VITE_HTML_OG_IMAGE=$FRONTEND_HTML_OG_IMAGE" >> .env
+          echo "VITE_HTML_OG_TITLE=$FRONTEND_HTML_OG_TITLE" >> .env
+          echo "VITE_HTML_OG_URL=$FRONTEND_HTML_OG_URL" >> .env
+          echo "VITE_HTML_BODY_CLASS=$FRONTEND_HTML_BODY_CLASS" >> .env
+          echo "VITE_SENTRY_DSN=$FRONTEND_SENTRY_DSN" >> .env
+          cp .env frontend/.env
+      - name: Build Podman images
+        run: podman-compose -f docker-compose-deploy.yml build
+      - name: Deploy Podman images
+        run: podman-compose -f docker-compose-deploy.yml up -d --force-recreate
+      - name: Notify Sentry of new release
+        run: |
+          curl -X POST "https://sentry.io/api/0/organizations/uva-aml/releases/" \
+          -H "Authorization: Bearer ${{ secrets.SENTRY_AUTH_TOKEN }}" \
+          -H "Content-Type: application/json" \
+          -d '{
+            "version": "${{ github.sha }}",
+            "refs": [{
+              "repository": "Amsterdam-Music-Lab/MUSCLE",
+              "commit": "${{ github.sha }}"
+            }],
+            "projects": ["muscle-frontend", "muscle-backend"],
+            "environment": "production"
+          }'
+      - name: Prune old images
+        run: podman image prune -a -f
+      - name: Check Podman images
+        run: podman-compose -f docker-compose-deploy.yml ps