Try out a new composite action

Author: leeyi45

.github/actions/build.js

@@ -1,3 +1,4 @@
+// @ts-check
 import getBuildCommand from '@sourceacademy/modules-repotools/builder';
 
 const buildCommand = getBuildCommand({
@@ -10,7 +11,7 @@ const buildCommand = getBuildCommand({
   outdir: 'dist',
   packages: 'external',
   platform: 'node',
-  target: 'node20'
+  target: 'node20',
 });
 
 await buildCommand.parseAsync();

.github/actions/src/init/action.yml

@@ -0,0 +1,49 @@
+name: Initialize Environment
+description: Checks out code and installs Yarn
+
+branding:
+  icon: play
+  color: green
+
+inputs:
+  workspace-name:
+    required: false
+    default: null
+    description: Name of the workspace you're initializing
+
+  install-deps:
+    required: false
+    default: true
+    description: "Should dependencies be installed? (default: true)"
+
+  playwright:
+    required: false
+    default: false
+    description: Should run the Playwright installation command
+
+runs:
+  using: composite
+  steps:
+    - name: Check out source code
+      uses: actions/checkout@v4
+
+    - name: Enable Corepack
+      run: corepack enable
+
+    - name: Use Node.js 💻
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: .node-version
+        cache: yarn
+
+    - name: Install Dependencies (Focused)
+      if: inputs.workspace-name != null && inputs.install-deps
+      run: yarn workspaces focus ${{ inputs.workspace-name }}
+
+    - name: Install Dependencies (General)
+      if: inputs.workspace-name == null && inputs.install-deps
+      run: yarn install --immutable
+
+    - name: Install Playwright
+      if: inputs.playwright == 'true' && inputs.install-deps
+      run: yarn playwright install --with-deps

.github/workflows/workflow-again.yml

@@ -14,14 +14,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
-
-      - name: Enable corepack
-        run: corepack enable
-
-      - name: Install action packages
-        run: yarn workspaces focus @sourceacademy/modules-github-actions
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
+        with:
+          package-name: '@sourceacademy/modules-github-actions'
 
       - name: Build actions
         run: |
@@ -46,26 +42,11 @@ jobs:
       matrix:
         lib: ${{ fromJson(needs.find-packages.outputs.libs) }}
     steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Use Node.js 💻
-        uses: actions/setup-node@v4
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
         with:
-          node-version-file: .node-version
-          cache: yarn
-
-      - name: Install Dependencies
-        run: yarn workspaces focus ${{ matrix.lib.name }}
-
-      - name: Install Playwright (if needed)
-        if: matrix.lib.changes == 'true' && matrix.lib.needsPlaywright
-        run: |
-          cd ${{ matrix.lib.directory }}
-          yarn playwright install --with-deps
+          package-name: ${{ matrix.lib.name }}
+          playwright: ${{ matrix.lib.changes && matrix.lib.needsPlaywright }}
 
       - name: Run Tests
         if: matrix.lib.changes == 'true'
@@ -90,17 +71,11 @@ jobs:
         tabInfo: ${{ fromJson(needs.find-packages.outputs.tabs) }}
 
     steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Use Node.js 💻
-        uses: actions/setup-node@v4
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
         with:
-          node-version-file: .node-version
-          cache: yarn
+          package-name: ${{ matrix.tabInfo.name }}
+          playwright: ${{ matrix.tabInfo.needsPlaywright && matrix.tabInfo.changes }}
 
       - name: Install Dependencies
         run: yarn workspaces focus ${{ matrix.tabInfo.name }}
@@ -114,20 +89,14 @@ jobs:
           path: ./build/tabs/${{ matrix.tabInfo.tabName }}.js
           key: ${{ matrix.tabInfo.name }}
 
-      - name: Install Playwright (if needed)
-        if: matrix.tabInfo.changes == 'true' && matrix.tabInfo.needsPlaywright
-        run: |
-          cd ${{ matrix.tabInfo.directory }}
-          yarn playwright install --with-deps
-
       - name: Run Tests
-        if: matrix.tabInfo.changes == 'true'
+        if: matrix.tabInfo.changes
         run: |
           cd ${{ matrix.tabInfo.directory }}
           yarn test
 
       - name: Run Auxillary Tasks
-        if: matrix.tabInfo.changes == 'true'
+        if: matrix.tabInfo.changes
         run: |
           cd ${{ matrix.tabInfo.directory }}
           yarn tsc
@@ -143,20 +112,10 @@ jobs:
         bundleInfo: ${{ fromJson(needs.find-packages.outputs.bundles) }}
 
     steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Use Node.js 💻
-        uses: actions/setup-node@v4
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
         with:
-          node-version-file: .node-version
-          cache: yarn
-
-      - name: Install Dependencies
-        run: yarn workspaces focus ${{ matrix.bundleInfo.name }}
+          package-name: ${{ matrix.bundleInfo.name }}
 
       - name: Build Bundle
         run: |
@@ -197,17 +156,46 @@ jobs:
       - tabs
 
     steps:
-      - name: Check out source code
-        uses: actions/checkout@v4
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
+        with:
+          package-name: '@sourceacademy/modules-devserver'
+          playwright: true
 
-      - name: Enable Corepack
-        run: corepack enable
+      - name: Run tests
+        run: |
+          cd ./devserver
+          yarn test
+      
+      - name: Run Auxillary Tasks
+        run: |
+          cd ./devserver
+          yarn tsc
 
-      - name: Use Node.js 💻
-        uses: actions/setup-node@v4
+  docserver:
+    name: Docs Server Tests
+    runs-on: ubuntu-latest
+    needs: libraries
+    steps:
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
         with:
-          node-version-file: .node-version
-          cache: yarn
+          package-name: '@sourceacademy/modules-docserver'
 
-      - name: Install Dependencies
-        run: yarn workspaces focus @sourceacademy/modules-devserver
+      - name: Build Docs
+        run: |
+          cd ./docs
+          yarn build
+
+  repo-tasks:
+    name: Repo Wide Tasks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Initialize Repo
+        uses: ./.github/actions/src/init
+        with:
+          package-name: '@sourceacademy/modules'
+      
+      - name: Lint Everything
+        run: yarn lint:all

src/bundles/nbody/package.json

@@ -3,17 +3,15 @@
   "version": "1.0.0",
   "private": true,
   "dependencies": {
-    "nbody": "^0.2.0"
+    "nbody": "^0.2.0",
+    "plotly.js-dist": "^2.17.1",
+    "three": "^0.175.0"
   },
   "devDependencies": {
     "@sourceacademy/modules-buildtools": "workspace:^",
-    "typescript": "^5.8.2"
-  },
-  "peerDependencies": {
     "@types/plotly.js": "^2.35.4",
     "@types/three": "^0.175.0",
-    "plotly.js-dist": "^2.17.1",
-    "three": "^0.175.0"
+    "typescript": "^5.8.2"
   },
   "type": "module",
   "exports": {

src/bundles/robot_simulation/package.json

@@ -7,6 +7,7 @@
     "three": "^0.175.0"
   },
   "devDependencies": {
+    "@dimforge/rapier3d-compat": "^0.11.2",
     "@sourceacademy/modules-buildtools": "workspace:^",
     "@types/three": "^0.175.0",
     "typescript": "^5.8.2"

src/tabs/Nbody/package.json

@@ -5,12 +5,16 @@
   "dependencies": {
     "@sourceacademy/modules-lib": "workspace:^",
     "nbody": "^0.2.0",
+    "plotly.js-dist": "^2.17.1",
     "react": "^18.3.1",
-    "react-dom": "^18.3.1"
+    "react-dom": "^18.3.1",
+    "three": "^0.175.0"
   },
   "devDependencies": {
     "@sourceacademy/modules-buildtools": "workspace:^",
-    "@types/react": "^18.3.1"
+    "@types/plotly.js": "^2.35.4",
+    "@types/react": "^18.3.1",
+    "@types/three": "^0.175.0"
   },
   "scripts": {
     "build": "buildtools build tab .",

yarn.lock

@@ -3173,13 +3173,12 @@ __metadata:
   resolution: "@sourceacademy/bundle-nbody@workspace:src/bundles/nbody"
   dependencies:
     "@sourceacademy/modules-buildtools": "workspace:^"
+    "@types/plotly.js": "npm:^2.35.4"
+    "@types/three": "npm:^0.175.0"
     nbody: "npm:^0.2.0"
+    plotly.js-dist: "npm:^2.17.1"
+    three: "npm:^0.175.0"
     typescript: "npm:^5.8.2"
-  peerDependencies:
-    "@types/plotly.js": ^2.35.4
-    "@types/three": ^0.175.0
-    plotly.js-dist: ^2.17.1
-    three: ^0.175.0
   languageName: unknown
   linkType: soft
 
@@ -3262,6 +3261,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@sourceacademy/bundle-robot_simulation@workspace:src/bundles/robot_simulation"
   dependencies:
+    "@dimforge/rapier3d-compat": "npm:^0.11.2"
     "@sourceacademy/modules-buildtools": "workspace:^"
     "@sourceacademy/modules-lib": "workspace:^"
     "@types/three": "npm:^0.175.0"
@@ -3694,10 +3694,14 @@ __metadata:
   dependencies:
     "@sourceacademy/modules-buildtools": "workspace:^"
     "@sourceacademy/modules-lib": "workspace:^"
+    "@types/plotly.js": "npm:^2.35.4"
     "@types/react": "npm:^18.3.1"
+    "@types/three": "npm:^0.175.0"
     nbody: "npm:^0.2.0"
+    plotly.js-dist: "npm:^2.17.1"
     react: "npm:^18.3.1"
     react-dom: "npm:^18.3.1"
+    three: "npm:^0.175.0"
   languageName: unknown
   linkType: soft
 
@@ -4463,6 +4467,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/plotly.js@npm:^2.35.4":
+  version: 2.35.8
+  resolution: "@types/plotly.js@npm:2.35.8"
+  checksum: 10c0/9b59a56fdef4c383aab03cf3e2597393140ed743ca1682e5512f95583787ae2f75dd3f980a56eed0eaa2f088ad0475fc915cb5d37875b08f499168966bc92e22
+  languageName: node
+  linkType: hard
+
 "@types/plotly.js@npm:^3.0.0":
   version: 3.0.0
   resolution: "@types/plotly.js@npm:3.0.0"
@@ -12381,6 +12392,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"plotly.js-dist@npm:^2.17.1":
+  version: 2.35.3
+  resolution: "plotly.js-dist@npm:2.35.3"
+  checksum: 10c0/cbdcfaaf72244e22a4311408f7bbad43e4462bc8dc5c7ea831f3dee3a2dc09bae6e390fc1eca92cc2b29f4cbae9507749b52fb3d7000a4115c666b6295e81a84
+  languageName: node
+  linkType: hard
+
 "plotly.js-dist@npm:^3.0.0":
   version: 3.0.1
   resolution: "plotly.js-dist@npm:3.0.1"