Skip to content

docs: remove included/readme image generation instructions #1068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 27, 2024
Merged

docs: remove included/readme image generation instructions #1068

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions included/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,30 +248,6 @@ By default, the included images run as `root` user. You can switch the user to t
$ docker run -it -v $PWD/src:/test -w /test -u node cypress/included:9.4.1
```

## Building and testing

To build a new image use command from the root of the repo

```shell
$ npm run add:included -- <Cypress version> <cypress/base:image>
# example
$ npm run add:included -- 9.4.1 cypress/browsers:node13.6.0-chrome80-ff72
```

You should also update the `circle.yml` file after creating the new image with

```shell
$ npm run build
```

You can test the new image by creating a new project and running headless tests. See the script [test.sh](test.sh) for an example.

The tests should finish successfully using local image. Now push the image to the Docker hub

```shell
docker push cypress/included:9.4.1
```

## GitHub Action

You can quickly run your tests in GitHub Actions using these images, see [GitHub Action example](https://github.com/cypress-io/github-action#docker-image) repository.
Expand Down