You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Build/Test Tools: Clarify the local development environment instructions by removing unnecesary references to Docker and mentioning some alternative container environments.
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,13 @@ If you are not using a package manager, see the [Node.js download page](https://
37
37
38
38
**Note:** WordPress currently only officially supports Node.js `20.x` and npm `10.x`.
39
39
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/).
41
43
42
44
### Development Environment Commands
43
45
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.
45
47
46
48
#### To start the development environment for the first time
47
49
@@ -97,7 +99,7 @@ npm run test:php -- --group <group name or ticket number>
97
99
#### Generating a code coverage report
98
100
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).
99
101
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.
101
103
102
104
```
103
105
npm run test:coverage
@@ -133,15 +135,15 @@ npm run env:start
133
135
134
136
#### Resetting the development environment
135
137
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.
137
139
138
140
```
139
141
npm run env:reset
140
142
```
141
143
142
144
### Apple Silicon machines and old MySQL/MariaDB versions
143
145
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:
145
147
146
148
- MySQL versions 5.7 and earlier
147
149
- MariaDB 5.5
@@ -155,7 +157,7 @@ services:
155
157
platform: linux/amd64
156
158
```
157
159
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.
0 commit comments