Skip to content

Commit 023e560

Browse files
committed
Build/Test Tools: Clarify the local development environment instructions by removing unnecesary references to Docker and mentioning some alternative container environments.
Props ninos-ego, johnbillion Fixes #63641 See #63628 git-svn-id: https://develop.svn.wordpress.org/trunk@60504 602fd350-edb4-49c9-b593-d223f7449a82
1 parent a0fa6f2 commit 023e560

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,13 @@ If you are not using a package manager, see the [Node.js download page](https://
3737

3838
**Note:** WordPress currently only officially supports Node.js `20.x` and npm `10.x`.
3939

40-
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.
40+
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.
41+
42+
**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/).
4143

4244
### Development Environment Commands
4345

44-
Ensure [Docker](https://www.docker.com/products/docker-desktop) is running before using these commands.
46+
Ensure your container environment is running before using these commands.
4547

4648
#### To start the development environment for the first time
4749

@@ -97,7 +99,7 @@ npm run test:php -- --group <group name or ticket number>
9799
#### Generating a code coverage report
98100
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).
99101

100-
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.
102+
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.
101103

102104
```
103105
npm run test:coverage
@@ -133,15 +135,15 @@ npm run env:start
133135

134136
#### Resetting the development environment
135137

136-
The development environment can be reset. This will destroy the database and attempt to remove the pulled Docker images.
138+
The development environment can be reset. This will destroy the database and attempt to remove the pulled container images.
137139

138140
```
139141
npm run env:reset
140142
```
141143

142144
### Apple Silicon machines and old MySQL/MariaDB versions
143145

144-
Older MySQL and MariaDB Docker images do not support Apple Silicon processors (M1, M2, etc.). This is true for:
146+
Older MySQL and MariaDB container images do not support Apple Silicon processors (M1, M2, etc.). This is true for:
145147

146148
- MySQL versions 5.7 and earlier
147149
- MariaDB 5.5
@@ -155,7 +157,7 @@ services:
155157
platform: linux/amd64
156158
```
157159

158-
Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in Docker needs to be disabled for this workaround.
160+
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.
159161

160162
## Credentials
161163

0 commit comments

Comments
 (0)