find-cypress-specs 1.42.0 → 1.43.1

package/README.md

@@ -38,6 +38,16 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## find number of machines
+
+If we find all the changed specs to run, we might need to decide how many machines we need. We can do a rough job by specifying the number of specs per machine plus the max number.
+
+```
+$ npx find-cypress-specs --branch main --specs-per-machine 4 --max-machines 5
+```
+
+For now, it is only useful when setting the GHA outputs.
+
 ## set GitHub Actions outputs
 
 If you add `--set-gha-outputs` command line switch, then the number of changed specs and the comma-separated file list will be set as GH Actions outputs `changedSpecsN` and `changedSpecs`. See [pr.yml](./.github/workflows/pr.yml) for example
@@ -52,6 +62,8 @@ If you add `--set-gha-outputs` command line switch, then the number of changed s
   run: echo ${{ steps.step1.outputs.changedSpecsN }} ${{ steps.step1.outputs.changedSpecs }}
 ```
 
+If you set the number of machines, it will set the output `machinesNeeded`
+
 ## Write GitHub Actions job summary
 
 You can output changes specs by using the parameter `--gha-summary`

package/bin/find.js

@@ -53,6 +53,9 @@ const args = arg({
   '--update-badge': Boolean,
   // output the list in Markdown format
   '--markdown': Boolean,
+  // optional: output the number of machines needed to run the tests
+  '--specs-per-machine': Number,
+  '--max-machines': Number,
   //
   // aliases
   '-n': '--names',
@@ -188,22 +191,55 @@ if (args['--test-counts']) {
       })
     }
 
+    let machinesNeeded
+    if (args['--specs-per-machine'] > 0 && args['--max-machines'] > 0) {
+      const specsPerMachine = args['--specs-per-machine']
+      const maxMachines = args['--max-machines']
+      machinesNeeded = Math.min(
+        Math.ceil(changedSpecs.length / specsPerMachine),
+        maxMachines,
+      )
+      debug(
+        'specs per machine %d with max %d machines',
+        specsPerMachine,
+        maxMachines,
+      )
+      debug(
+        'from %d specs, set %d output machinesNeeded',
+        changedSpecs.length,
+        machinesNeeded,
+      )
+    }
+
     if (args['--set-gha-outputs']) {
       debug('setting GitHub Actions outputs changedSpecsN and changedSpecs')
       debug('changedSpecsN %d', changedSpecs.length)
       debug('plus changedSpecs')
       core.setOutput('changedSpecsN', changedSpecs.length)
       core.setOutput('changedSpecs', changedSpecs.join(','))
+      core.setOutput('machinesNeeded', machinesNeeded)
     }
+
     if (args['--gha-summary']) {
       debug('writing GitHub Actions summary')
-      const summary = changedSpecs.length
-        ? `Found that ${pluralize(
-            'spec',
-            changedSpecs.length,
+      let summary
+
+      if (changedSpecs.length > 0) {
+        summary = `Found that ${pluralize(
+          'spec',
+          changedSpecs.length,
+          true,
+        )} changed: ${changedSpecs.join(', ')}`
+        if (machinesNeeded > 0) {
+          summary += `\nestimated ${pluralize(
+            'machine',
+            machinesNeeded,
             true,
-          )} changed: ${changedSpecs.join(', ')}`
-        : 'No specs changed'
+          )} needed`
+        }
+      } else {
+        summary = 'No specs changed'
+      }
       if (process.env.GITHUB_STEP_SUMMARY) {
         core.summary.addRaw(summary).write()
       } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.42.0",
+  "version": "1.43.1",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [