Skip to content

Commit 8075ec9

Browse files
authored
docs: update README Docker section (#913)
1 parent afe9cea commit 8075ec9

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,15 +149,14 @@ cd cypress-example-kitchensink
149149
npm ci
150150
```
151151

152-
> [!NOTE]
153-
> For simplicity, the Docker examples below use a repository reference such as `cypress/base` with the `latest` version tag. To select an earlier version, replace `latest` with an explicit tag, for example `cypress/base:20.15.1`. Explicit version tags are recommended for production. Usage is further explained in [Tag Selection](https://github.com/cypress-io/cypress-docker-images/blob/master/README.md#tag-selection).
152+
NOTE: For simplicity, the Docker examples below use a repository reference such as `cypress/base` with the `latest` version tag. To select an earlier version, replace `latest` with an explicit tag, for example `cypress/base:20.15.1`. Explicit version tags are recommended for production. Usage is further explained in the [Tags](https://github.com/cypress-io/cypress-docker-images/blob/master/README.md#tags) section of the [Cypress Docker Images - README](https://github.com/cypress-io/cypress-docker-images/blob/master/README.md).
154153

155154
#### cypress/base
156155

157156
The following example uses a [cypress/base](https://github.com/cypress-io/cypress-docker-images/tree/master/base) image which itself contains no browsers. You will use the Electron browser bundled with Cypress instead. To run the Docker container, execute the following:
158157

159158
```shell
160-
docker run -it --rm -v .:/e2e -w /e2e cypress/base:latest
159+
docker run -it --rm -v .:/app -w /app cypress/base:latest
161160
```
162161

163162
When the container prompt appears, enter:
@@ -173,7 +172,7 @@ exit
173172
With a [cypress/browsers](https://github.com/cypress-io/cypress-docker-images/tree/master/browsers) image you have the additional choice of Chrome, Edge and Firefox browsers. Execute the following:
174173

175174
```shell
176-
docker run -it --rm -v .:/e2e -w /e2e cypress/browsers:latest
175+
docker run -it --rm -v .:/app -w /app cypress/browsers:latest
177176
```
178177

179178
When the container prompt appears, enter:
@@ -193,14 +192,13 @@ The [cypress/included](https://github.com/cypress-io/cypress-docker-images/tree/
193192
Execute the following to run the container with a one-line command, testing with the Chrome browser:
194193

195194
```shell
196-
docker run -it --rm -v .:/e2e -w /e2e --entrypoint bash cypress/included:latest -c 'npm run test:ci:chrome' # use for matching Cypress versions
195+
docker run -it --rm -v .:/app -w /app --entrypoint bash cypress/included:latest -c 'npm run test:ci:chrome' # use for matching Cypress versions
197196
```
198197

199198
Replace the `latest` tag in the above command using the Cypress version from the repo's [package.json](./package.json), if this repository has not yet been updated to the latest released Cypress version.
200199
Note that mismatched versions will cause errors.
201200

202-
> [!NOTE]
203-
> Additional browsers Chrome, Edge and Firefox are only installed in `linux/amd64` architecture images `cypress/browsers` and `cypress/included`. Browsers are not available pre-installed for `linux/arm64` architecture images. The Electron browser, which is built-in to Cypress, is available in all images and architectures.
201+
NOTE: Additional browsers Chrome, Edge and Firefox are only installed in `linux/amd64` architecture images `cypress/browsers` and `cypress/included`. Browsers are not available pre-installed for `linux/arm64` architecture images. The Electron browser, which is built-in to Cypress, is available in all images and architectures.
204202

205203
### CI Testing
206204

0 commit comments

Comments
 (0)