Skip to content

docs: update contributing image size section #1080

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.

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 31, 2024

Conversation

MikeMcC399
Copy link
Collaborator

Issue

The CONTRIBUTING > Minimize image sizes document section is outdated concerning Debian base versions.

The default BASE_IMAGE is determined by the same named property in the factory/.env file.

When cypress/factory was introduced through PR #812 in January 2023 BASE_IMAGE was set to debian:bullseye-slim (Debian 11).

Since PR #1057 on May 30, 2024 BASE_IMAGE is set to debian:12-slim (codename bookworm).

The prior PR #597 from March 2022, introduced bullseye-slim for Node.js 16 and above whilst retaining buster-slim for Node.js 14 and below.

Summary

Node.js 18 is the lowest currently supported version, so all currently supported Cypress Docker images have been generated using a debian:*slim variant.

Descriptions of the process before cypress/factory was introduced are no longer relevant for future contributions.

Change

The section CONTRIBUTING > Minimize image sizes is reworked to give better advice for changes that contributors may need to make.

Obsolete information regarding image generation prior to the introduction of cypress/factory is removed.

A snapshot of current sizes is included:

docker images --format "table {{.Repository}} {{.Tag}} {{.Size}}"
REPOSITORY TAG SIZE
cypress/factory 4.0.0 506MB
cypress/base 20.13.1 640MB
cypress/browsers node-20.13.1-chrome-125.0.6422.60-1-ff-126.0-edge-125.0.2535.51-1 2.14GB
cypress/included 13.10.0 2.86GB

@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 marked this pull request as ready for review May 31, 2024 09:02
@jennifer-shehane jennifer-shehane merged commit 7a93d58 into cypress-io:master May 31, 2024
33 checks passed
@MikeMcC399 MikeMcC399 deleted the image-size branch June 4, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants