Update workflows to not execute jobs at all if there were no detected changes for the corresponding package

Author: leeyi45

.github/actions/src/info/__tests__/index.test.ts

@@ -1,9 +1,10 @@
 import type { Dirent } from 'fs';
 import fs from 'fs/promises';
 import pathlib from 'path';
+import * as core from '@actions/core';
 import { describe, expect, test, vi } from 'vitest';
 import * as git from '../../commons.js';
-import { getAllPackages, getRawPackages } from '../index.js';
+import { getAllPackages, getRawPackages, main } from '../index.js';
 
 const mockedCheckChanges = vi.spyOn(git, 'checkForChanges');
 
@@ -212,3 +213,34 @@ describe(getAllPackages, () => {
     expect(results['@sourceacademy/modules-lib'].changes).toEqual(true);
   });
 });
+
+describe(main, () => {
+  vi.spyOn(git, 'getGitRoot').mockResolvedValue('root');
+  const mockedSetOutput = vi.spyOn(core, 'setOutput');
+
+  vi.spyOn(core.summary, 'addHeading').mockImplementation(() => core.summary);
+  vi.spyOn(core.summary, 'addTable').mockImplementation(() => core.summary);
+  vi.spyOn(core.summary, 'write').mockImplementation(() => Promise.resolve(core.summary));
+
+  test('Does not write packages with no changes to the output', async () => {
+    mockedCheckChanges.mockImplementation(path => {
+      return Promise.resolve(path === 'root/src/tabs/tab0');
+    });
+
+    await main();
+    const { mock: { calls } } = mockedSetOutput;
+
+    expect(mockedSetOutput).toHaveBeenCalledTimes(6);
+
+    expect(calls[0]).toEqual(['bundles', []]);
+    expect(calls[1]).toEqual(['tabs', [expect.objectContaining({ changes: true })]]);
+    expect(calls[2]).toEqual(['libs', []]);
+    
+    // These next two are undefined because the mock implementations
+    // don't return any info about them
+    expect(calls[3]).toEqual(['devserver', undefined]);
+    expect(calls[4]).toEqual(['docserver', undefined]);
+
+    expect(calls[5]).toEqual(['workflows', false]);
+  });
+});

.github/actions/src/info/index.ts

@@ -208,14 +208,14 @@ function setOutputs(
   devserver: PackageRecord,
   docserver: PackageRecord
 ) {
-  core.setOutput('bundles', bundles);
-  core.setOutput('tabs', tabs);
-  core.setOutput('libs', libs);
+  core.setOutput('bundles', bundles.filter(x => x.changes));
+  core.setOutput('tabs', tabs.filter(x => x.changes));
+  core.setOutput('libs', libs.filter(x => x.changes));
   core.setOutput('devserver', devserver);
   core.setOutput('docserver', docserver);
 }
 
-async function main() {
+export async function main() {
   const gitRoot = await getGitRoot();
   const { packages, bundles, tabs, libs } = await getAllPackages(gitRoot);
 

.github/workflows/pull-request.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Check out source code
         uses: actions/checkout@v5
 
-      - name: Initialize Repo
+      - name: Initialize Github Actions
         uses: ./.github/actions/src/init
         with:
           package-name: '@sourceacademy/modules-github-actions'
@@ -63,11 +63,9 @@ jobs:
 
     steps:
       - name: Check out source code
-        if: matrix.lib.changes
         uses: actions/checkout@v5
 
-      - name: Initialize Repo
-        if: matrix.lib.changes
+      - name: Initialize ${{ matrix.lib.name }}
         uses: ./.github/actions/src/init
         with:
           package-name: ${{ matrix.lib.name }}
@@ -76,15 +74,15 @@ jobs:
 
       # Only thing we really need to do on Windows is run tests (without coverage)
       - name: Run Tests (Windows)
-        if: matrix.lib.changes && matrix.os == 'windows-latest'
+        if: matrix.os == 'windows-latest'
         run: yarn workspaces foreach -A --include ${{ matrix.lib.name }} run test
 
       - name: Run Tests (Ubuntu)
-        if: matrix.lib.changes && matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-latest'
         run: yarn workspaces foreach -A --include ${{ matrix.lib.name }} run test --coverage
 
       - name: Run Auxillary Tasks
-        if: matrix.lib.changes && matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-latest'
         run: yarn workspaces foreach -A --include ${{ matrix.lib.name }} run tsc
 
   tabs:
@@ -97,24 +95,20 @@ jobs:
     name: ${{ matrix.tabInfo.tabName }} Tab
     steps:
       - name: Check out source code
-        if: matrix.tabInfo.changes
         uses: actions/checkout@v5
 
-      - name: Initialize Repo
-        if: matrix.tabInfo.changes
+      - name: Initialize ${{ matrix.tabInfo.tabName }}
         uses: ./.github/actions/src/init
         with:
           package-name: ${{ matrix.tabInfo.name }}
           playwright: ${{ matrix.tabInfo.needsPlaywright && matrix.tabInfo.changes }}
 
       - name: Build Tab
-        if: matrix.tabInfo.changes
         run: |
           cd ${{ matrix.tabInfo.directory }}
           yarn build
 
       - name: Upload Tab Artifact
-        if: matrix.tabInfo.changes
         uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.tabInfo.tabName }}-tab
@@ -124,13 +118,11 @@ jobs:
         # https://github.com/vitest-dev/vitest/issues/5477
         # Known Vitest issue for coverage running in browser mode
         # Momentarily disable coverage checking on Github Actions for tabs
-        if: matrix.tabInfo.changes
         run: |
           cd ${{ matrix.tabInfo.directory }}
           yarn test
 
       - name: Run Auxillary Tasks
-        if: matrix.tabInfo.changes
         run: |
           cd ${{ matrix.tabInfo.directory }}
           yarn tsc
@@ -145,31 +137,26 @@ jobs:
     name: ${{ matrix.bundleInfo.bundleName }} Bundle
     steps:
       - name: Check out source code
-        if: matrix.bundleInfo.changes
         uses: actions/checkout@v5
 
-      - name: Initialize Repo
-        if: matrix.bundleInfo.changes
+      - name: Initialize ${{ matrix.bundleInfo.name }}
         uses: ./.github/actions/src/init
         with:
           package-name: ${{ matrix.bundleInfo.name }}
           playwright: ${{ matrix.bundleInfo.needsPlaywright }}
 
       - name: Build Bundle
-        if: matrix.bundleInfo.changes
         run: |
           cd ${{ matrix.bundleInfo.directory }}
           yarn build
           yarn tsc
 
       - name: Build Bundle Docs
-        if: matrix.bundleInfo.changes
         run: |
           cd ${{ matrix.bundleInfo.directory }}
           yarn buildtools build docs
 
       - name: Run Tests
-        if: matrix.bundleInfo.changes
         run: |
           cd ${{ matrix.bundleInfo.directory }}
           yarn test --coverage