@cypress/github-action 5.4.0 → 5.5.0
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 +25 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
- generate a [robust custom build id](#robust-custom-build-id) to allow re-running the workflow
|
|
37
37
|
- use different [working-directory](#working-directory)
|
|
38
38
|
- use [Yarn Classic](#yarn-classic)
|
|
39
|
+
- use [Yarn Modern](#yarn-modern)
|
|
39
40
|
- use [Yarn workspaces](#yarn-workspaces)
|
|
40
41
|
- use [custom cache key](#custom-cache-key)
|
|
41
42
|
- run tests on multiple [Node versions](#node-versions)
|
|
@@ -1018,7 +1019,29 @@ See [example-yarn-classic.yml](.github/workflows/example-yarn-classic.yml) for a
|
|
|
1018
1019
|
|
|
1019
1020
|
[](.github/workflows/example-yarn-classic.yml)
|
|
1020
1021
|
|
|
1021
|
-
|
|
1022
|
+
### Yarn Modern
|
|
1023
|
+
|
|
1024
|
+
To install dependencies using a `yarn.lock` file from [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) you need to override the default [Yarn 1 (Classic)](https://classic.yarnpkg.com/) installation command `yarn --frozen-lockfile`. You can do this by using the `install-command` parameter and specifying `yarn install` for example:
|
|
1025
|
+
|
|
1026
|
+
```yaml
|
|
1027
|
+
name: example-yarn-modern
|
|
1028
|
+
on: push
|
|
1029
|
+
jobs:
|
|
1030
|
+
yarn-classic:
|
|
1031
|
+
runs-on: ubuntu-22.04
|
|
1032
|
+
steps:
|
|
1033
|
+
- name: Checkout
|
|
1034
|
+
uses: actions/checkout@v3
|
|
1035
|
+
- name: Cypress run
|
|
1036
|
+
uses: cypress-io/github-action@v5
|
|
1037
|
+
with:
|
|
1038
|
+
working-directory: examples/yarn-modern
|
|
1039
|
+
install-command: yarn install
|
|
1040
|
+
```
|
|
1041
|
+
|
|
1042
|
+
See [example-yarn-modern.yml](.github/workflows/example-yarn-modern.yml) for an example.
|
|
1043
|
+
|
|
1044
|
+
[](.github/workflows/example-yarn-modern.yml)
|
|
1022
1045
|
|
|
1023
1046
|
### Yarn workspaces
|
|
1024
1047
|
|
|
@@ -1200,17 +1223,7 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
|
|
|
1200
1223
|
|
|
1201
1224
|
### Installation
|
|
1202
1225
|
|
|
1203
|
-
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.
|
|
1204
|
-
|
|
1205
|
-
#### Yarn Modern
|
|
1206
|
-
|
|
1207
|
-
The above default `yarn` installation command can be replaced for [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) using the `install-command` parameter, for example:
|
|
1208
|
-
|
|
1209
|
-
```yml
|
|
1210
|
-
- uses: cypress-io/github-action@v5
|
|
1211
|
-
with:
|
|
1212
|
-
install-command: yarn install
|
|
1213
|
-
```
|
|
1226
|
+
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. See the [Yarn Modern](#yarn-modern) example for instructions on installing dependencies using this later version.
|
|
1214
1227
|
|
|
1215
1228
|
#### Minimum Node.js
|
|
1216
1229
|
|