feat: support yarn (#15)

* feat: support yarn if yarn.lock file is found

* add note about yarn lock and debugging

Author: bahmutov

README.md

@@ -137,6 +137,21 @@ jobs:
           wait-on: http://localhost:8080
 ```
 
+## Notes
+
+### Installation
+
+This action installs local dependencies using lock files. If `yarn.lock` file is found, the install uses `yarn --frozen-lockfile` command. Otherwise it expects to find `package-lock.json` and install using `npm ci` command.
+
+### Debugging
+
+You can see verbose messages from GitHub Actions by setting the following secrets (from [Debugging Actions Guide](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs))
+
+```
+ACTIONS_RUNNER_DEBUG: true
+ACTIONS_STEP_DEBUG: true
+```
+
 ## More information
 
 - [Building actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/building-actions) docs

dist/index.js

@@ -1143,16 +1143,23 @@ const exec = __webpack_require__(986)
 const hasha = __webpack_require__(309)
 const execa = __webpack_require__(955)
 const { restoreCache, saveCache } = __webpack_require__(211)
+const fs = __webpack_require__(747)
 
-const packageLockHash = hasha.fromFileSync('./package-lock.json')
+const useYarn = fs.existsSync('yarn.lock')
+const lockFilename = useYarn ? 'yarn.lock' : 'package-lock.json'
+const lockHash = hasha.fromFileSync(lockFilename)
 const platformAndArch = `${process.platform}-${process.arch}`
 
 const NPM_CACHE = (() => {
-  const o = {
-    inputPath: '~/.npm',
-    restoreKeys: `npm-${platformAndArch}-`
+  const o = {}
+  if (useYarn) {
+    o.inputPath = '~/.cache/yarn'
+    o.restoreKeys = `yarn-${platformAndArch}-`
+  } else {
+    o.inputPath = '~/.npm'
+    o.restoreKeys = `npm-${platformAndArch}-`
   }
-  o.primaryKey = o.restoreKeys + packageLockHash
+  o.primaryKey = o.restoreKeys + lockHash
   return o
 })()
 
@@ -1161,7 +1168,7 @@ const CYPRESS_BINARY_CACHE = (() => {
     inputPath: '~/.cache/Cypress',
     restoreKeys: `cypress-${platformAndArch}-`
   }
-  o.primaryKey = o.restoreKeys + packageLockHash
+  o.primaryKey = o.restoreKeys + lockHash
   return o
 })()
 
@@ -1197,10 +1204,16 @@ const saveCachedCypressBinary = () => {
 }
 
 const install = () => {
-  console.log('installing NPM dependencies')
   // prevent lots of progress messages during install
   core.exportVariable('CI', '1')
-  return exec.exec('npm ci')
+
+  if (useYarn) {
+    console.log('installing NPM dependencies using Yarn')
+    return exec.exec('yarn --frozen-lockfile')
+  } else {
+    console.log('installing NPM dependencies')
+    return exec.exec('npm ci')
+  }
 }
 
 const verifyCypressBinary = () => {

index.js

@@ -4,16 +4,23 @@ const exec = require('@actions/exec')
 const hasha = require('hasha')
 const execa = require('execa')
 const { restoreCache, saveCache } = require('cache/lib/index')
+const fs = require('fs')
 
-const packageLockHash = hasha.fromFileSync('./package-lock.json')
+const useYarn = fs.existsSync('yarn.lock')
+const lockFilename = useYarn ? 'yarn.lock' : 'package-lock.json'
+const lockHash = hasha.fromFileSync(lockFilename)
 const platformAndArch = `${process.platform}-${process.arch}`
 
 const NPM_CACHE = (() => {
-  const o = {
-    inputPath: '~/.npm',
-    restoreKeys: `npm-${platformAndArch}-`
+  const o = {}
+  if (useYarn) {
+    o.inputPath = '~/.cache/yarn'
+    o.restoreKeys = `yarn-${platformAndArch}-`
+  } else {
+    o.inputPath = '~/.npm'
+    o.restoreKeys = `npm-${platformAndArch}-`
   }
-  o.primaryKey = o.restoreKeys + packageLockHash
+  o.primaryKey = o.restoreKeys + lockHash
   return o
 })()
 
@@ -22,7 +29,7 @@ const CYPRESS_BINARY_CACHE = (() => {
     inputPath: '~/.cache/Cypress',
     restoreKeys: `cypress-${platformAndArch}-`
   }
-  o.primaryKey = o.restoreKeys + packageLockHash
+  o.primaryKey = o.restoreKeys + lockHash
   return o
 })()
 
@@ -58,10 +65,16 @@ const saveCachedCypressBinary = () => {
 }
 
 const install = () => {
-  console.log('installing NPM dependencies')
   // prevent lots of progress messages during install
   core.exportVariable('CI', '1')
-  return exec.exec('npm ci')
+
+  if (useYarn) {
+    console.log('installing NPM dependencies using Yarn')
+    return exec.exec('yarn --frozen-lockfile')
+  } else {
+    console.log('installing NPM dependencies')
+    return exec.exec('npm ci')
+  }
 }
 
 const verifyCypressBinary = () => {