search

cypress-io / cypress-docker-images

Docker images with Cypress dependencies and browsers
https://on.cypress.io/continuous-integration
MIT License
1.02k stars 380 forks source link

Lack of Information in cypress/base Docker Image Documentation #1026

Open eduardoacskimlinks opened 5 months ago

eduardoacskimlinks commented 5 months ago

Current Behavior: When attempting to run the cypress/base:20.11.0 Docker image, we are having difficulty determining the specific setup being utilized.

Upon reviewing the cypressbase documentation, we observed a lack of information regarding the underlying configuration of the Docker image.

Expected Behavior: We anticipate that the documentation for the cypress/base Docker image will provide comprehensive details about the operating system, npm version, and yarn version employed in each project version.

This enhancement would greatly facilitate understanding and managing the Docker image, enabling users to make informed decisions about its compatibility and suitability for their environments.

MikeMcC399 commented 3 months ago

@eduardoacskimlinks

Thank you for highlighting your documentation needs!

cypress/base:20.11.0 is built with:

To bridge the gap until there are some documentation enhancements made, here is some information which may assist you to find the information for other images.

To take the example of cypress/base:20.11.0, you can run commands inside a Docker container to reveal configurations and versions:

docker run --rm -it --entrypoint bash cypress/base:20.11.0
root@f40cf2680f65:/# cat /etc/os-release
PRETTY_NAME="Debian GNU/Linux 11 (bullseye)"
NAME="Debian GNU/Linux"
VERSION_ID="11"
VERSION="11 (bullseye)"
VERSION_CODENAME=bullseye
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"
root@f40cf2680f65:/# cat /etc/debian_version
11.8
root@f40cf2680f65:/# node -v
v20.11.0
root@f40cf2680f65:/# npm -v
10.2.4
root@f40cf2680f65:/# yarn -v
1.22.19

You can also extract each item individually. The following will run in an Ubuntu terminal or Microsoft Windows PowerShell:

docker run --rm --entrypoint cat cypress/base:20.11.0 /etc/os-release
docker run --rm --entrypoint cat cypress/base:20.11.0 /etc/debian_version
docker run --rm --entrypoint bash cypress/base:20.11.0 -c 'node -v'
docker run --rm --entrypoint bash cypress/base:20.11.0 -c 'npm -v'
docker run --rm --entrypoint bash cypress/base:20.11.0 -c 'yarn -v'

Some of the version information is also available on Docker Hub under cypress/base:20.11.0.

You can also get a better idea of how the images are built, if you look at cypress/factory.