@cypress/github-action 5.7.0 → 5.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/action.yml +1 -1
- package/dist/index.js +12 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -345,7 +345,7 @@ jobs:
|
|
|
345
345
|
|
|
346
346
|
[](.github/workflows/example-recording.yml)
|
|
347
347
|
|
|
348
|
-
**Tip 1:** We recommend using the action with `on: [push]` instead of `on: [pull_request]` to get the most accurate information related to the commit on
|
|
348
|
+
**Tip 1:** We recommend using the action with `on: [push]` instead of `on: [pull_request]` to get the most accurate information related to the commit on Cypress Cloud. With pull requests, the merge commit is created automatically and might not correspond to a meaningful commit in the repository.
|
|
349
349
|
|
|
350
350
|
**Tip 2:** we recommend passing the `GITHUB_TOKEN` secret (created by the GH Action automatically) as an environment variable. This will allow correctly identifying every build and avoid confusion when re-running a build.
|
|
351
351
|
|
|
@@ -554,7 +554,7 @@ jobs:
|
|
|
554
554
|
|
|
555
555
|
### Parallel
|
|
556
556
|
|
|
557
|
-
**Note:** Cypress parallelization requires a [Cypress Cloud](https://on.cypress.io/
|
|
557
|
+
**Note:** Cypress parallelization requires a [Cypress Cloud](https://on.cypress.io/cloud-introduction) account.
|
|
558
558
|
|
|
559
559
|
You can spin multiple containers running in parallel using `strategy: matrix` argument. Just add more dummy items to the `containers: [1, 2, ...]` array to spin more free or paid containers. Then use `record` and `parallel` parameters to [load balance tests](https://on.cypress.io/parallelization).
|
|
560
560
|
|
|
@@ -1357,7 +1357,7 @@ If you add `workflow_dispatch` event to your workflow, you will be able to start
|
|
|
1357
1357
|
|
|
1358
1358
|
### Outputs
|
|
1359
1359
|
|
|
1360
|
-
This action sets a GitHub step output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/
|
|
1360
|
+
This action sets a GitHub step output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/cloud-introduction) using the action parameter setting `record: true` (see [Record test results on Cypress Cloud](#record-test-results-on-cypress-cloud)). Note that using a [Custom test command](#custom-test-command) with the `command` parameter overrides the `record` parameter and in this case no `dashboardUrl` step output is saved.
|
|
1361
1361
|
|
|
1362
1362
|
This is an example of using the step output `dashboardUrl`:
|
|
1363
1363
|
|
package/action.yml
CHANGED
|
@@ -4,7 +4,7 @@ description: 'GitHub Action for running Cypress end-to-end and component tests'
|
|
|
4
4
|
author: 'Cypress-io'
|
|
5
5
|
inputs:
|
|
6
6
|
record:
|
|
7
|
-
description: 'Sends test results to Cypress
|
|
7
|
+
description: 'Sends test results to Cypress Cloud'
|
|
8
8
|
required: false
|
|
9
9
|
default: false
|
|
10
10
|
auto-cancel-after-failures:
|
package/dist/index.js
CHANGED
|
@@ -74479,7 +74479,7 @@ const noLockFile = () => {
|
|
|
74479
74479
|
process.exit(1)
|
|
74480
74480
|
}
|
|
74481
74481
|
|
|
74482
|
-
// enforce the same
|
|
74482
|
+
// enforce the same npm cache folder across different operating systems
|
|
74483
74483
|
const NPM_CACHE_FOLDER = path.join(homeDirectory, '.npm')
|
|
74484
74484
|
const getNpmCache = () => {
|
|
74485
74485
|
const o = {}
|
|
@@ -74505,7 +74505,7 @@ const getNpmCache = () => {
|
|
|
74505
74505
|
o.inputPath = NPM_CACHE_FOLDER
|
|
74506
74506
|
}
|
|
74507
74507
|
|
|
74508
|
-
// use exact restore key to prevent
|
|
74508
|
+
// use exact restore key to prevent npm cache from growing
|
|
74509
74509
|
// https://glebbahmutov.com/blog/do-not-let-npm-cache-snowball/
|
|
74510
74510
|
o.restoreKeys = o.primaryKey = key
|
|
74511
74511
|
return o
|
|
@@ -74532,21 +74532,21 @@ const getCypressBinaryCache = () => {
|
|
|
74532
74532
|
}
|
|
74533
74533
|
|
|
74534
74534
|
const restoreCachedNpm = () => {
|
|
74535
|
-
debug('trying to restore cached
|
|
74535
|
+
debug('trying to restore cached npm modules')
|
|
74536
74536
|
const NPM_CACHE = getNpmCache()
|
|
74537
74537
|
return restoreCache([NPM_CACHE.inputPath], NPM_CACHE.primaryKey, [
|
|
74538
74538
|
NPM_CACHE.restoreKeys
|
|
74539
74539
|
]).catch((e) => {
|
|
74540
|
-
console.warn('Restoring
|
|
74540
|
+
console.warn('Restoring npm cache error: %s', e.message)
|
|
74541
74541
|
})
|
|
74542
74542
|
}
|
|
74543
74543
|
|
|
74544
74544
|
const saveCachedNpm = () => {
|
|
74545
|
-
debug('saving
|
|
74545
|
+
debug('saving npm modules')
|
|
74546
74546
|
const NPM_CACHE = getNpmCache()
|
|
74547
74547
|
return saveCache([NPM_CACHE.inputPath], NPM_CACHE.primaryKey).catch(
|
|
74548
74548
|
(e) => {
|
|
74549
|
-
console.warn('Saving
|
|
74549
|
+
console.warn('Saving npm cache error: %s', e.message)
|
|
74550
74550
|
}
|
|
74551
74551
|
)
|
|
74552
74552
|
}
|
|
@@ -74584,7 +74584,7 @@ const install = () => {
|
|
|
74584
74584
|
// prevent lots of progress messages during install
|
|
74585
74585
|
core.exportVariable('CI', '1')
|
|
74586
74586
|
core.exportVariable('CYPRESS_CACHE_FOLDER', CYPRESS_CACHE_FOLDER)
|
|
74587
|
-
// set
|
|
74587
|
+
// set npm cache path in case the user has custom install command
|
|
74588
74588
|
core.exportVariable('npm_config_cache', NPM_CACHE_FOLDER)
|
|
74589
74589
|
|
|
74590
74590
|
// Note: need to quote found tool to avoid Windows choking on
|
|
@@ -74596,7 +74596,7 @@ const install = () => {
|
|
|
74596
74596
|
}
|
|
74597
74597
|
|
|
74598
74598
|
if (useYarn()) {
|
|
74599
|
-
debug('installing
|
|
74599
|
+
debug('installing npm dependencies using Yarn')
|
|
74600
74600
|
return io.which('yarn', true).then((yarnPath) => {
|
|
74601
74601
|
debug(`yarn at "${yarnPath}"`)
|
|
74602
74602
|
return exec.exec(
|
|
@@ -74606,7 +74606,7 @@ const install = () => {
|
|
|
74606
74606
|
)
|
|
74607
74607
|
})
|
|
74608
74608
|
} else if (usePnpm()) {
|
|
74609
|
-
debug('installing
|
|
74609
|
+
debug('installing npm dependencies using pnpm')
|
|
74610
74610
|
return io.which('pnpm', true).then((pnpmPath) => {
|
|
74611
74611
|
debug(`pnpm at "${pnpmPath}"`)
|
|
74612
74612
|
return exec.exec(
|
|
@@ -74616,7 +74616,7 @@ const install = () => {
|
|
|
74616
74616
|
)
|
|
74617
74617
|
})
|
|
74618
74618
|
} else {
|
|
74619
|
-
debug('installing
|
|
74619
|
+
debug('installing npm dependencies')
|
|
74620
74620
|
return io.which('npm', true).then((npmPath) => {
|
|
74621
74621
|
debug(`npm at "${npmPath}"`)
|
|
74622
74622
|
return exec.exec(quote(npmPath), ['ci'], cypressCommandOptions)
|
|
@@ -75034,7 +75034,7 @@ const runTests = async () => {
|
|
|
75034
75034
|
'cypress'
|
|
75035
75035
|
const cypress = require(cypressModulePath)
|
|
75036
75036
|
|
|
75037
|
-
debug('Running Cypress tests using
|
|
75037
|
+
debug('Running Cypress tests using Module API')
|
|
75038
75038
|
debug(`requiring cypress dependency, cwd is ${process.cwd()}`)
|
|
75039
75039
|
debug(`working directory ${workingDirectory}`)
|
|
75040
75040
|
debug(`resolved cypress ${cypressModulePath}`)
|
|
@@ -75180,7 +75180,7 @@ const generateSummary = async (testResults) => {
|
|
|
75180
75180
|
.addHeading('Cypress Results', 2)
|
|
75181
75181
|
.addTable([headers, summaryRows])
|
|
75182
75182
|
.addLink(
|
|
75183
|
-
testResults.runUrl ? 'View
|
|
75183
|
+
testResults.runUrl ? 'View run in Cypress Cloud' : '',
|
|
75184
75184
|
testResults.runUrl || ''
|
|
75185
75185
|
)
|
|
75186
75186
|
.write()
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cypress/github-action",
|
|
3
|
-
"version": "5.7.
|
|
3
|
+
"version": "5.7.2",
|
|
4
4
|
"description": "GitHub Action for running Cypress end-to-end and component tests",
|
|
5
5
|
"private": false,
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"supports-color": "9.3.1"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@types/node": "18.16.
|
|
49
|
+
"@types/node": "18.16.5",
|
|
50
50
|
"@vercel/ncc": "0.36.1",
|
|
51
51
|
"husky": "8.0.3",
|
|
52
52
|
"markdown-link-check": "3.11.1",
|