Refactor CI workflows

.env.test.example

@@ -11,7 +11,13 @@
 # -------------------------------------------------------------------------------------------------------------------- #
 # Cypress Configuration
 # -------------------------------------------------------------------------------------------------------------------- #
+# Project ID
+CYPRESS_PROJECT_ID=
 
+
+# -------------------------------------------------------------------------------------------------------------------- #
+# Test Configuration
+# -------------------------------------------------------------------------------------------------------------------- #
 # Clever Auth Credentials
 CYPRESS_CLEVER_USERNAME=
 CYPRESS_CLEVER_PASSWORD=

.github/actions/deploy-firestore-indexes/action.yml

@@ -0,0 +1,43 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+# roar-dashboard/deploy-firestore-indexes
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+
+name: Deploy Firestore Indexes
+description: Deploys the ROAR Firestore indexes to both the admin and assessment projects.
+inputs:
+  admin-service-account-key:
+    description: 'The admin Firebase service account key to authenticate with.'
+    required: true
+  assessment-service-account-key:
+    description: 'The assessment Firebase service account key to authenticate with.'
+    required: true
+  admin-project-id:
+    description: 'The admin Firebase project ID to deploy the indexes to.'
+    required: true
+  assessment-project-id:
+    description: 'The assessment Firebase project ID to deploy the indexes to.'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Deploy admin indexes
+      uses: w9jds/firebase-action@v13
+      with:
+        args: deploy --only firestore:indexes
+      env:
+        GCP_SA_KEY: ${{ inputs.admin-service-account-key }}
+        PROJECT_ID: ${{ inputs.admin-project-id }}
+        PROJECT_PATH: ./firebase/admin
+
+    - name: Deploy assessment indexes
+      uses: w9jds/firebase-action@v13
+      with:
+        args: deploy --only firestore:indexes
+      env:
+        GCP_SA_KEY: ${{ inputs.assessment-service-account-key }}
+        PROJECT_ID: ${{ inputs.assessment-project-id }}
+        PROJECT_PATH: ./firebase/assessment

.github/actions/deploy-firestore-rules/action.yml

@@ -0,0 +1,43 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+# roar-dashboard/deploy-firestore-rules
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+
+name: Deploy Firestore Rules
+description: Deploys the ROAR Firestore rules to both the admin and assessment projects.
+inputs:
+  admin-service-account-key:
+    description: 'The admin Firebase service account key to authenticate with.'
+    required: true
+  assessment-service-account-key:
+    description: 'The assessment Firebase service account key to authenticate with.'
+    required: true
+  admin-project-id:
+    description: 'The admin Firebase project ID to deploy the indexes to.'
+    required: true
+  assessment-project-id:
+    description: 'The assessment Firebase project ID to deploy the indexes to.'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Deploy admin rules
+      uses: w9jds/firebase-action@v13
+      with:
+        args: deploy --only firestore:rules
+      env:
+        GCP_SA_KEY: ${{ inputs.admin-service-account-key }}
+        PROJECT_ID: ${{ inputs.admin-project-id }}
+        PROJECT_PATH: ./firebase/admin
+
+    - name: Deploy assessment rules
+      uses: w9jds/firebase-action@v13
+      with:
+        args: deploy --only firestore:rules
+      env:
+        GCP_SA_KEY: ${{ inputs.assessment-service-account-key }}
+        PROJECT_ID: ${{ inputs.assessment-project-id }}
+        PROJECT_PATH: ./firebase/assessment

.github/actions/setup-node-environment/action.yml

@@ -0,0 +1,20 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+# roar-dashboard/setup-node-environment
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+
+name: Setup Node.js environment
+description: Sets up environment by installing Node.js and the application's npm dependencies.
+runs:
+  using: 'composite'
+  steps:
+    # Install Node.js and cache global npm modules
+    - name: Install Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+        cache: 'npm'
+
+    # Install npm dependencies
+    - name: Install dependencies
+      run: npm ci
+      shell: bash

.github/actions/update-deployment-manifest/action.yml

@@ -0,0 +1,48 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+# roar-dashboard/update-deployment-manifest
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+
+name: 'Update Deployment Manifest'
+description: 'Updates the deployment manifests in additional ROAR project repositories.'
+inputs:
+  project-name:
+    description: 'Name of the project'
+    required: true
+  project-repo:
+    description: 'Repository to update'
+    required: true
+  token:
+    description: 'GitHub PAT to access the repository'
+    required: true
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        repository: ${{ inputs.project-repo }}
+        token: ${{ inputs.token }}
+
+    - name: Update deployment manifest
+      shell: bash
+      run: |
+        branch_name="devops/update-deployment-manifest"
+        git checkout -b $branch_name || git checkout $branch_name
+
+        latest_sha=$(git rev-parse HEAD)
+        yq e -i ".app.latest = \"$latest_sha\"" deployment-manifest.yml
+
+        echo "branch_name=$branch_name" >> $GITHUB_OUTPUT
+        echo "latest_sha=$latest_sha" >> $GITHUB_OUTPUT
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v4
+      with:
+        token: ${{ inputs.token }}
+        commit-message: 'Bump yeatmanlab/roar-dashboard to ${{ steps.update-release-manifest.outputs.latest_sha }}'
+        add-paths: 'deployment-manifest.yml'
+        branch: ${{ steps.update-release-manifest.outputs.branch_name }}
+        title: 'Update release manifest target'
+        body: |
+          ## Summary
+          This automated PR updates the deployment manifest to the latest yeatmanlab/roar-dashboard target SHA ${{ steps.update-release-manifest.outputs.latest_sha }}.

.github/actions/whitelist-appcheck-environment/action.yml

@@ -0,0 +1,44 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+# roar-dashboard/whitelist-appcheck-environment
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––– #
+
+name: Whitelist AppCheck environment
+description: Whitelists a preview environment for AppCheck.
+inputs:
+  project-id:
+    description: 'The Firebase project ID to whitelist the domain for.'
+    required: true
+  service-account-key:
+    description: 'The Firebase service account key to authenticate with.'
+    required: true
+  appcheck-site-key:
+    description: 'The Firebase AppCheck site key to update the domain for.'
+    required: true
+  environment-url:
+    description: 'The URL of the preview environment to whitelist.'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Authenticate with Google Cloud
+      uses: google-github-actions/auth@v2
+      with:
+        credentials_json: ${{ inputs.service-account-key }}
+
+    - name: Set up Google Cloud CLI
+      uses: google-github-actions/setup-gcloud@v2
+      with:
+        project_id: gse-roar-assessment
+
+    - name: Add environment URL to AppCheck whitelist
+      shell: bash
+      run: |
+        CURRENT_DOMAINS=$(gcloud recaptcha keys describe ${{ inputs.appcheck-site-key }} --format="value(webSettings.allowedDomains)" | tr ';' '\n')
+        NEW_DOMAIN=$(echo ${{ inputs.environment-url }} | sed 's|https://||')
+        ALL_DOMAINS=$(echo -e "${CURRENT_DOMAINS}\n${NEW_DOMAIN}")
+        UPDATED_DOMAINS=$(echo "$ALL_DOMAINS" | sort | uniq | paste -sd ',' -)
+        gcloud recaptcha keys update ${{ inputs.appcheck-site-key }} --domains="$UPDATED_DOMAINS" --web