Merge pull request #55 from liiingo/main

Allow customizable working directory for monorepo support
trymbill · Feb 5, 2021 · 4067c6b · 4067c6b
2 parents 4db48df + 8c61d96
commit 4067c6b
Show file tree

Hide file tree

Showing 8 changed files with 344 additions and 260 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v12.19.0
diff --git a/README.md b/README.md
@@ -22,6 +22,19 @@ This Github action enables you to take the screenshots and videos generated by C
 
 **Required** Slack channels to upload to
 
+### `workdir`
+
+**Optional** The folder where Cypress stores screenshots and videos on the build machine.
+
+Default: `cypress`
+
+(this relative path resolves to `/home/runner/work/<REPO_NAME>/<REPO_NAME>/cypress`)
+
+If your project uses Cypress from the project root folder, the default value will work for you.
+But if your project uses Cypress in a subfolder (like most monorepos), you'll need to provide the relative path to that folder
+(i.e. `e2e/cypress`).
+(Don't include a trailing slash on your path!)
+
 ## Examples
 
 ### Upload results after every push

diff --git a/action.yml b/action.yml
@@ -10,6 +10,9 @@ inputs:
   channels:
     description: 'Slack channels'
     required: true
+  workdir:
+    description: 'The path of the directory where Cypress stores its screenshots. Defaults to `./cypress`. No trailing slashes, please.'
+    required: false
 outputs:
   result:
     description: 'Result of video and screenshot uploads'

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cypress-slack-video-upload-action",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "private": true,
   "description": "Github action that takes the generated screenshots and videos from a Cypress test and uploads them to Slack",
   "main": "lib/main.js",

diff --git a/src/main.ts b/src/main.ts
@@ -8,6 +8,7 @@ async function run(): Promise<void> {
     core.debug('INIT!')
     const token = core.getInput('token')
     const channels = core.getInput('channels')
+    const workdir = core.getInput('workdir') || 'cypress'
 
     core.debug(`Token: ${token}`)
     core.debug(`Channels: ${channels}`)
@@ -17,8 +18,8 @@ async function run(): Promise<void> {
     core.debug('Slack SDK initialized successfully')
 
     core.debug('Checking for videos and/or screenshots from cypress')
-    const videos = walkSync('cypress', { globs: ['**/*.mp4'] })
-    const screenshots = walkSync('cypress', { globs: ['**/*.png'] })
+    const videos = walkSync(workdir, { globs: ['**/*.mp4'] })
+    const screenshots = walkSync(workdir, { globs: ['**/*.png'] })
 
     if (videos.length <= 0 && screenshots.length <= 0) {
       core.debug('No videos or screenshots found. Exiting!')
@@ -50,7 +51,7 @@ async function run(): Promise<void> {
 
           await slack.files.upload({
             filename: screenshot,
-            file: createReadStream(`cypress/${screenshot}`),
+            file: createReadStream(`${workdir}/${screenshot}`),
             thread_ts: threadID,
             channels: channelId
           })
@@ -69,7 +70,7 @@ async function run(): Promise<void> {
 
           await slack.files.upload({
             filename: video,
-            file: createReadStream(`cypress/${video}`),
+            file: createReadStream(`${workdir}/${video}`),
             thread_ts: threadID,
             channels: channelId
           })