ci: update GitHub workflows and Code Coverage settings (#955)

* ci: update GitHub workflows * ci: add codecov.yml * ci(codecov): enable bundle analysis * ci: save Algolia application ID to secrets * ci: update the bundle name for codecov bundle analysis report
trendmicro-frontend · Dec 6, 2024 · 5e10b69 · 5e10b69
1 parent d797c22
commit 5e10b69
Show file tree

Hide file tree

Showing 25 changed files with 468 additions and 65 deletions.
diff --git a/.github/workflows/algolia-search-indexing.yml b/.github/workflows/algolia-search-indexing.yml
@@ -7,30 +7,31 @@ on:
   workflow_dispatch:
 
 env:
-  ALGOLIA_APPLICATION_ID: 7V00GBK8V8
+  ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
   ALGOLIA_INDEX: tonic-ui-v2
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18.x]
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Install yarn
-      run: npm install -g yarn
-    - name: Install and build
-      run: |
-        yarn up
-        yarn install
-        yarn build
-    - name: Algolia search indexing
-      env:
-        ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
-      run: |
-        cd packages/react-docs; ../../node_modules/.bin/babel-node scripts/algolia-search-indexing.js
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Fetch the entire Git history to access the latest tag release
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install yarn
+        run: npm install -g yarn
+      - name: Install and build
+        run: |
+          yarn up
+          yarn install
+          yarn build
+      - name: Algolia search indexing
+        env:
+          ALGOLIA_ADMIN_API_KEY: ${{ secrets.ALGOLIA_ADMIN_API_KEY }}
+        run: |
+          cd packages/react-docs; ../../node_modules/.bin/babel-node scripts/algolia-search-indexing.js
diff --git a/.github/workflows/ci-branch.yml b/.github/workflows/ci-branch.yml
@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - v2
+  schedule:
+    # run daily
+    - cron: '0 0 * * *'
   workflow_dispatch:
 
 permissions:
@@ -25,7 +28,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Check installed versions
         run: |
@@ -54,6 +57,8 @@ jobs:
           yarn install
 
       - name: Build & Test
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         run: |
           yarn build
           yarn lint

diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml
@@ -28,7 +28,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Check installed versions
         run: |
@@ -58,6 +58,8 @@ jobs:
           yarn install
 
       - name: Build & Test
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         run: |
           yarn build
           yarn lint
@@ -114,7 +116,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Configure environment variables
         env:

diff --git a/.github/workflows/ci-publish.yml b/.github/workflows/ci-publish.yml
@@ -24,7 +24,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install packages
         run: |

diff --git a/.github/workflows/ci-tag.yml b/.github/workflows/ci-tag.yml
@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Check installed versions
         run: |
@@ -54,6 +54,8 @@ jobs:
           yarn install
 
       - name: Build & Test
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         run: |
           yarn build
           yarn lint

diff --git a/.github/workflows/update-yarn-lock-file.yml b/.github/workflows/update-yarn-lock-file.yml
@@ -1,11 +1,6 @@
-name: Update yarn.lock file
+name: Update `yarn.lock` file
 
 on:
-  # run daily
-  schedule:
-    - cron: '0 0 * * *'
-
-  # allow manual trigger
   workflow_dispatch:
 
 # Ensure only one lock action can run at a time
@@ -18,19 +13,20 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write
-    strategy:
-      matrix:
-        node-version: [18.x]
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Install yarn
-      run: npm install -g yarn
-    - name: Update yarn.lock
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        scripts/update-yarn-lock-file.sh
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Fetch the entire Git history to access the latest tag release
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install yarn
+        run: npm install -g yarn
+      - name: Update yarn.lock
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          scripts/update-yarn-lock-file.sh
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,11 @@
+coverage:
+  # https://docs.codecov.com/docs/commit-status
+  status:
+    project:
+      default:
+        target: auto 
+        threshold: 2%
+    patch:
+      default:
+        target: auto 
+        threshold: 2%
diff --git a/packages/changelog-github/package.json b/packages/changelog-github/package.json
@@ -26,6 +26,7 @@
     "@babel/eslint-plugin": "^7.0.0",
     "@babel/plugin-transform-runtime": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
+    "@codecov/rollup-plugin": "^1.5.1",
     "@rollup/plugin-babel": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.0",
     "@trendmicro/babel-config": "^1.0.2",

diff --git a/packages/changelog-github/rollup.config.mjs b/packages/changelog-github/rollup.config.mjs
@@ -1,8 +1,11 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { codecovRollupPlugin } from '@codecov/rollup-plugin';
 import { babel } from '@rollup/plugin-babel';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
 
+const pkg = createRequire(import.meta.url)('./package.json');
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
@@ -27,6 +30,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   },
   {
@@ -40,6 +49,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   }
 ];
diff --git a/packages/codemod/src/react/v2.0.0/__tests__/import-react-icons.test.js b/packages/codemod/src/react/v2.0.0/__tests__/import-react-icons.test.js
@@ -1,5 +1,5 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import jscodeshift from 'jscodeshift';
 import transform from '@tonic-ui/codemod/src/react/v2.0.0/import-react-icons';
 

diff --git a/packages/react-base/package.json b/packages/react-base/package.json
@@ -34,6 +34,7 @@
     "@babel/plugin-transform-runtime": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
+    "@codecov/rollup-plugin": "^1.5.1",
     "@emotion/babel-plugin": "^11.10.0",
     "@emotion/jest": "^11.10.0",
     "@rollup/plugin-babel": "^6.0.0",

diff --git a/packages/react-base/rollup.config.mjs b/packages/react-base/rollup.config.mjs
@@ -1,8 +1,11 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { codecovRollupPlugin } from '@codecov/rollup-plugin';
 import { babel } from '@rollup/plugin-babel';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
 
+const pkg = createRequire(import.meta.url)('./package.json');
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
@@ -26,6 +29,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   },
   {
@@ -39,6 +48,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   }
 ];
diff --git a/packages/react-hooks/package.json b/packages/react-hooks/package.json
@@ -30,6 +30,7 @@
     "@babel/plugin-transform-runtime": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
+    "@codecov/rollup-plugin": "^1.5.1",
     "@rollup/plugin-babel": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.0",
     "@testing-library/jest-dom": "^6.0.0",

diff --git a/packages/react-hooks/rollup.config.mjs b/packages/react-hooks/rollup.config.mjs
@@ -1,8 +1,11 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { codecovRollupPlugin } from '@codecov/rollup-plugin';
 import { babel } from '@rollup/plugin-babel';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
 
+const pkg = createRequire(import.meta.url)('./package.json');
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
@@ -27,6 +30,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   },
   {
@@ -40,6 +49,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   }
 ];
diff --git a/packages/react-icons/package.json b/packages/react-icons/package.json
@@ -27,6 +27,7 @@
     "@babel/plugin-transform-runtime": "^7.24.0",
     "@babel/preset-env": "^7.24.0",
     "@babel/preset-react": "^7.23.3",
+    "@codecov/rollup-plugin": "^1.5.1",
     "@emotion/babel-plugin": "^11.11.0",
     "@emotion/react": "11.x",
     "@trendmicro/babel-config": "^1.0.2",

diff --git a/packages/react-icons/rollup.config.mjs b/packages/react-icons/rollup.config.mjs
@@ -1,8 +1,11 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { codecovRollupPlugin } from '@codecov/rollup-plugin';
 import { babel } from '@rollup/plugin-babel';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
 
+const pkg = createRequire(import.meta.url)('./package.json');
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
@@ -26,6 +29,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   },
   {
@@ -39,6 +48,12 @@ export default [
     plugins: [
       nodeResolve(),
       babel({ babelHelpers: 'bundled' }),
+      // Put the Codecov rollup plugin after all other plugins
+      codecovRollupPlugin({
+        enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
+        bundleName: pkg.name,
+        uploadToken: process.env.CODECOV_TOKEN,
+      }),
     ],
   }
 ];