From f0377ba4783d87c9c5e3c549767d1b2dfbf548aa Mon Sep 17 00:00:00 2001 From: Ninos Ego Date: Mon, 30 Jun 2025 08:43:11 +0200 Subject: [PATCH 1/4] Docs: Add `podman` as additional recommendation --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fc8c00f6821af..a9c3d08d53ed0 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ If you are not using a package manager, see the [Node.js download page](https:// **Note:** WordPress currently only officially supports Node.js `20.x` and npm `10.x`. -You will also need [Docker](https://www.docker.com/products/docker-desktop) installed and running on your computer. Docker is the virtualization software that powers the local development environment. Docker can be installed just like any other regular application. +You will also need a container environment (e.g. [Docker](https://www.docker.com/products/docker-desktop) or [Podman](https://podman-desktop.io/)) installed and running on your computer. The container environment is the virtualization software that powers the local development environment. Both applications can be installed just like any other regular application. ### Development Environment Commands -Ensure [Docker](https://www.docker.com/products/docker-desktop) is running before using these commands. +Ensure either [Docker](https://www.docker.com/products/docker-desktop) or [Podman](https://podman-desktop.io/) are running before using these commands. #### To start the development environment for the first time @@ -97,7 +97,7 @@ npm run test:php -- --group #### Generating a code coverage report PHP code coverage reports are [generated daily](https://github.com/WordPress/wordpress-develop/actions/workflows/test-coverage.yml) and [submitted to Codecov.io](https://app.codecov.io/gh/WordPress/wordpress-develop). -After the local Docker environment has [been installed and started](#to-start-the-development-environment-for-the-first-time), the following command can be used to generate a code coverage report. +After the local container environment has [been installed and started](#to-start-the-development-environment-for-the-first-time), the following command can be used to generate a code coverage report. ``` npm run test:coverage @@ -109,7 +109,7 @@ The command will generate three coverage reports in HTML, PHP, and text formats, #### To restart the development environment -You may want to restart the environment if you've made changes to the configuration in the `docker-compose.yml` or `.env` files. Restart the environment with: +You may want to restart the environment if you've made changes to the configuration in the `compose.yml` or `.env` files. Restart the environment with: ``` npm run env:restart @@ -133,7 +133,7 @@ npm run env:start #### Resetting the development environment -The development environment can be reset. This will destroy the database and attempt to remove the pulled Docker images. +The development environment can be reset. This will destroy the database and attempt to remove the pulled container images. ``` npm run env:reset @@ -141,12 +141,12 @@ npm run env:reset ### Apple Silicon machines and old MySQL/MariaDB versions -Older MySQL and MariaDB Docker images do not support Apple Silicon processors (M1, M2, etc.). This is true for: +Older MySQL and MariaDB container images do not support Apple Silicon processors (M1, M2, etc.). This is true for: - MySQL versions 5.7 and earlier - MariaDB 5.5 -When using these versions on an Apple Silicon machine, you must create a `docker-compose.override.yml` file with the following contents: +When using these versions on an Apple Silicon machine, you must create a `compose.override.yml` file with the following contents: ``` services: @@ -155,7 +155,7 @@ services: platform: linux/amd64 ``` -Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in Docker needs to be disabled for this workaround. +Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in containers needs to be disabled for this workaround. ## Credentials From 1552bae65c5e2184746aa8b975001ad72ccf6209 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Thu, 24 Jul 2025 12:28:49 +0100 Subject: [PATCH 2/4] Adjust the phrasing to include other alternative container environments. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a9c3d08d53ed0..59e666dafdca5 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,13 @@ If you are not using a package manager, see the [Node.js download page](https:// **Note:** WordPress currently only officially supports Node.js `20.x` and npm `10.x`. -You will also need a container environment (e.g. [Docker](https://www.docker.com/products/docker-desktop) or [Podman](https://podman-desktop.io/)) installed and running on your computer. The container environment is the virtualization software that powers the local development environment. Both applications can be installed just like any other regular application. +You will also need a container environment such as [Docker Desktop](https://www.docker.com/products/docker-desktop) installed and running on your computer. The container environment is the virtualization software that powers the local development environment and can be installed just like any other regular application. + +**Note:** WordPress currently only officially supports Docker but several container environments are available and should generally be compatible, such as [Colima](https://github.com/abiosoft/colima), [OrbStack](https://orbstack.dev/), [Podman Desktop](https://podman-desktop.io/), and [Rancher Desktop](https://rancherdesktop.io/). ### Development Environment Commands -Ensure either [Docker](https://www.docker.com/products/docker-desktop) or [Podman](https://podman-desktop.io/) are running before using these commands. +Ensure your container environment is running before using these commands. #### To start the development environment for the first time From 1fc7b398d3067c750a4001dec9b851df0fe84f9f Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Thu, 24 Jul 2025 12:30:28 +0100 Subject: [PATCH 3/4] These are still prefixed. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59e666dafdca5..4332629005f69 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ The command will generate three coverage reports in HTML, PHP, and text formats, #### To restart the development environment -You may want to restart the environment if you've made changes to the configuration in the `compose.yml` or `.env` files. Restart the environment with: +You may want to restart the environment if you've made changes to the configuration in the `docker-compose.yml` or `.env` files. Restart the environment with: ``` npm run env:restart @@ -148,7 +148,7 @@ Older MySQL and MariaDB container images do not support Apple Silicon processors - MySQL versions 5.7 and earlier - MariaDB 5.5 -When using these versions on an Apple Silicon machine, you must create a `compose.override.yml` file with the following contents: +When using these versions on an Apple Silicon machine, you must create a `docker-compose.override.yml` file with the following contents: ``` services: From 4a025dd0edb67782ca47f88be2f870b25500d22c Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Thu, 24 Jul 2025 12:31:14 +0100 Subject: [PATCH 4/4] More tweaks. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4332629005f69..028c0bd5b1f63 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,7 @@ services: platform: linux/amd64 ``` -Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in containers needs to be disabled for this workaround. +Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in your container environment (if applicable) needs to be disabled for this workaround. ## Credentials