find-cypress-specs 1.21.0 → 1.22.0

package/README.md

@@ -19,6 +19,20 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## set GitHub Actions outputs
+
+If you add `--set-gh-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
+
+```yml
+- name: Print specs changed against the parent of this branch 🌳
+  # and set GitHub Actions output
+  id: step1
+  run: node ./bin/find --branch main --parent --set-gha-outputs
+
+- name: Print set outputs
+  run: echo ${{ steps.step1.outputs.changedSpecsN }} ${{ steps.step1.outputs.changedSpecs }}
+```
+
 ## against the parent commit
 
 When dealing with a long-term branch, you do not want to see the changed files in the main branch. Instead, you want to only consider the specs changed in the _current_ branch all the way to its parent commit. You can pass the flag `--parent` to only pick the modified and added specs.

package/bin/find.js

@@ -12,6 +12,7 @@ const { getTestNames, countTags } = require('find-test-names')
 const consoleTable = require('console.table')
 const debug = require('debug')('find-cypress-specs')
 const { getDependsInFolder } = require('spec-change')
+const core = require('@actions/core')
 
 const args = arg({
   '--names': Boolean,
@@ -32,7 +33,10 @@ const args = arg({
   // and consider specs that import a changes source file changed to
   // The value of this argument is the subfolder with Cypress tests, like "cypress"
   '--trace-imports': String,
-
+  // when enabled, this code uses GitHub Actions Core package
+  // to set two named outputs, one for number of changed specs
+  // another for actual list of files
+  '--set-gha-outputs': Boolean,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -160,6 +164,11 @@ if (args['--names'] || args['--tags']) {
   }
   let changedSpecs = specs.filter((file) => changedFiles.includes(file))
   debug('changed %d specs %o', changedSpecs.length, changedSpecs)
+  if (args['--set-gha-outputs']) {
+    debug('setting GitHub Actions outputs changedSpecsN and changedSpecs')
+    core.setOutput('changedSpecsN', changedSpecs.length)
+    core.setOutput('changedSpecs', changedSpecs.join(','))
+  }
 
   if (args['--tagged']) {
     const splitTags = args['--tagged']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -52,6 +52,7 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
+    "@actions/core": "^1.10.0",
     "arg": "^5.0.1",
     "console.table": "^0.10.0",
     "debug": "^4.3.3",