(chore) Add automated dependency update workflow

denniskigen · denniskigen · commit 955c125075ff · 2025-04-25T11:14:11.000+03:00
Adds a workflow and script to automatically check for and update OpenMRS dependencies, including verification and deduplication. Other changes include:

- Augmenting the existing Transifex integration pull workflow with auto-approve/merge capabilities
- Improving workflow documentation
- Moving config files such as the i18next parser config and Jest setup into the tools directory
- Updating the primary CI workflow to use Node 20
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Cache dependencies
         id: cache-dependencies
@@ -59,7 +59,7 @@ jobs:
         run: yarn playwright test
 
       - name: Stop dev server
-        if: "!cancelled()"
+        if: '!cancelled()'
         run: docker stop $(docker ps -a -q)
 
       - name: 📤 Upload report
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -1,4 +1,4 @@
-name: Node.js CI
+name: OpenMRS CI
 
 on:
   push:
@@ -23,7 +23,7 @@ jobs:
       - name: 🛠️ Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: 20
 
       - name: 💾 Cache dependencies
         id: cache
@@ -66,7 +66,7 @@ jobs:
       - name: 🛠️ Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: 20
 
       - name: 💾 Cache dependencies
         id: cache
@@ -120,7 +120,7 @@ jobs:
       - name: 🛠️ Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: 20
           registry-url: 'https://registry.npmjs.org'
 
       - name: 💾 Cache dependencies
diff --git a/.github/workflows/update-openmrs-deps.yml b/.github/workflows/update-openmrs-deps.yml
@@ -0,0 +1,94 @@
+# Workflow to automatically check and update OpenMRS dependencies
+# Runs hourly and can be triggered manually
+
+name: 'Check for OpenMRS Dependency Updates'
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Runs every hour at minute 30
+    - cron: '30 * * * *'
+
+jobs:
+  check-for-updates:
+    name: Check for updates to OpenMRS libraries
+    runs-on: ubuntu-latest
+
+    if: github.repository_owner == 'openmrs'
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      # Step 1: Check out repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1   # Shallow clone for better performance
+
+      # Step 2: Setup Node.js environment
+      - name: 🟢 Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      # Step 3: Cache dependencies
+      - name: 💾 Cache dependencies
+        id: cache
+        uses: actions/cache@v4
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+
+      # Step 4: Install dependencies if cache miss
+      - name: 📦 Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: yarn install --immutable
+
+      # Step 5: Run dependency update check
+      - name: ✅ Check for updates
+        run: node ./tools/update-openmrs-deps.mjs
+
+      # Step 6: Create PR with updates if necessary
+      - name: ⬆️ Create PR if necessary
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: '(chore) Update OpenMRS dependencies'
+          title: '(chore) Update OpenMRS dependencies'
+          body: |
+            # OpenMRS Dependencies Update
+
+            This PR contains updates to OpenMRS dependencies.
+
+            ## Changes
+            * Automated dependency updates for OpenMRS packages
+            * Generated by the OpenMRS Dependency Update workflow
+
+            ## Verification
+            - [ ] All dependencies are valid versions
+            - [ ] No breaking changes introduced
+
+            > This PR was automatically generated and will be automatically merged if checks pass.
+          branch: 'chore/update-openmrs-deps'
+          author: 'OpenMRS Bot <infrastructure@openmrs.org>'
+          token: ${{ secrets.OMRS_BOT_GH_TOKEN }}
+          labels: |
+            dependencies
+            automated-pr
+          delete-branch: true    # Clean up branch after merge
+
+      # Step 7: Auto-approve the PR if created or updated
+      - name: ✅ Auto approve PR
+        if: steps.cpr.outputs.pull-request-operation == 'created' || steps.cpr.outputs.pull-request-operation == 'updated'
+        run: gh pr review --approve "${{ steps.cpr.outputs.pull-request-number }}"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # Step 8: Auto-merge the PR if created or updated
+      - name: 🔀 Auto merge PR
+        if: steps.cpr.outputs.pull-request-operation == 'created' || steps.cpr.outputs.pull-request-operation == 'updated'
+        run: gh pr merge --auto --squash "${{ steps.cpr.outputs.pull-request-number }}"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/jest.config.js b/jest.config.js
@@ -1,21 +1,24 @@
+/**
+ * @returns {Promise<import('jest').Config>}
+ */
 module.exports = {
   clearMocks: true,
   transform: {
-    "^.+\\.tsx?$": "@swc/jest",
+    '^.+\\.tsx?$': '@swc/jest',
   },
-  transformIgnorePatterns: ["/node_modules/(?!@openmrs)"],
+  transformIgnorePatterns: ['/node_modules/(?!@openmrs)'],
   moduleNameMapper: {
-    "\\.(s?css)$": "identity-obj-proxy",
-    "@openmrs/esm-framework": "@openmrs/esm-framework/mock",
-    "^dexie$": require.resolve("dexie"),
-    "^lodash-es/(.*)$": "lodash/$1",
-    "^lodash-es$": "lodash",
-    "^uuid$": "<rootDir>/node_modules/uuid/dist/index.js",
+    '\\.(s?css)$': 'identity-obj-proxy',
+    '@openmrs/esm-framework': '@openmrs/esm-framework/mock',
+    '^dexie$': require.resolve('dexie'),
+    '^lodash-es/(.*)$': 'lodash/$1',
+    '^lodash-es$': 'lodash',
+    '^uuid$': '<rootDir>/node_modules/uuid/dist/index.js',
   },
-  setupFilesAfterEnv: ["<rootDir>/src/setup-tests.ts"],
-  testEnvironment: "jsdom",
+  setupFilesAfterEnv: ['<rootDir>/tools/setup-tests.ts'],
+  testEnvironment: 'jsdom',
   testEnvironmentOptions: {
-    url: "http://localhost/",
+    url: 'http://localhost/',
   },
-  testPathIgnorePatterns: ["<rootDir>/e2e"],
+  testPathIgnorePatterns: ['<rootDir>/e2e'],
 };
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -1,32 +1,30 @@
-import { devices, PlaywrightTestConfig } from "@playwright/test";
-import * as dotenv from "dotenv";
+import { devices, type PlaywrightTestConfig } from '@playwright/test';
+import * as dotenv from 'dotenv';
 dotenv.config();
 
 // See https://playwright.dev/docs/test-configuration.
 const config: PlaywrightTestConfig = {
-  testDir: "./e2e/specs",
+  testDir: './e2e/specs',
   timeout: 3 * 60 * 1000,
   expect: {
     timeout: 40 * 1000,
   },
   workers: 1,
   forbidOnly: !!process.env.CI,
   retries: 0,
-  reporter: process.env.CI
-    ? [["junit", { outputFile: "results.xml" }], ["html"]]
-    : [["html"]],
-  globalSetup: require.resolve("./e2e/core/global-setup"),
+  reporter: process.env.CI ? [['junit', { outputFile: 'results.xml' }], ['html']] : [['html']],
+  globalSetup: require.resolve('./e2e/core/global-setup'),
   use: {
     baseURL: `${process.env.E2E_BASE_URL}/spa/`,
-    locale: "en-US",
-    storageState: "e2e/storageState.json",
-    video: "retain-on-failure",
+    locale: 'en-US',
+    storageState: 'e2e/storageState.json',
+    video: 'retain-on-failure',
   },
   projects: [
     {
-      name: "chromium",
+      name: 'chromium',
       use: {
-        ...devices["Desktop Chrome"],
+        ...devices['Desktop Chrome'],
       },
     },
   ],
diff --git a/src/declarations.d.ts b/src/declarations.d.ts
diff --git a/src/setup-tests.ts b/src/setup-tests.ts
diff --git a/tools/setup-tests.ts b/tools/setup-tests.ts
@@ -0,0 +1 @@
+import '@testing-library/jest-dom';
diff --git a/tools/update-openmrs-deps.mjs b/tools/update-openmrs-deps.mjs
@@ -0,0 +1,42 @@
+import { execSync } from 'node:child_process';
+
+try {
+  execSync(`yarn up --fixed '@openmrs/esm-framework@next' '@openmrs/esm-form-engine-lib@next' 'openmrs@next'`, {
+    stdio: ['ignore', 'inherit', 'inherit'],
+    windowsHide: true,
+  });
+} catch (error) {
+  console.error(`Error while updating dependencies: ${error.message ?? error}`);
+  process.exit(1);
+}
+
+try {
+  execSync(`yarn dedupe`, {
+    stdio: ['ignore', 'inherit', 'inherit'],
+    windowsHide: true,
+  });
+} catch (error) {
+  console.error(`Error while deduplicating dependencies: ${error.message ?? error}`);
+  process.exit(1);
+}
+
+try {
+  execSync(`git diff-index --quiet HEAD --`, {
+    stdio: 'ignore',
+    windowsHide: true,
+  });
+  process.exit(0);
+} catch (error) {
+  // git diff-index --quite HEAD --
+  // exits with status 1 if there are changes; we only need to run yarn verify if there are changes
+}
+
+try {
+  execSync(`yarn verify`, {
+    stdio: ['ignore', 'inherit', 'inherit'],
+    windowsHide: true,
+  });
+} catch (error) {
+  console.error(`Error while running yarn verify: ${error.message ?? error}. Updates require manual intervention.`);
+  process.exit(1);
+}
diff --git a/webpack.config.js b/webpack.config.js
@@ -1,2 +1,2 @@
-const config = (module.exports = require("openmrs/default-webpack-config"));
+const config = (module.exports = require('openmrs/default-webpack-config'));
 module.exports = config;
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-const config = (module.exports = require("openmrs/default-webpack-config"));`
	`1`	`+const config = (module.exports = require('openmrs/default-webpack-config'));`
`2`	`2`	`module.exports = config;`