Skip to content

Commit f90cad2

Browse files
committed
Build/Test Tools: Remove unnecessary docker branding
1 parent 27233a0 commit f90cad2

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// For format details, see https://aka.ms/devcontainer.json.
22
{
33
"name": "WordPress Core Development",
4-
"dockerComposeFile": "docker-compose.yml",
4+
"dockerComposeFile": "compose.yml",
55
"service": "app",
66
"workspaceFolder": "/workspace",
77

.github/workflows/local-docker-environment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
paths:
1010
# Any changes to Docker related files.
1111
- '.env.example'
12-
- 'docker-compose.yml'
12+
- 'compose.yml'
1313
# Any changes to local environment related files
1414
- 'tools/local-env/**'
1515
# These files configure npm and the task runner. Changes could affect the outcome.
@@ -33,7 +33,7 @@ on:
3333
paths:
3434
# Any changes to Docker related files.
3535
- '.env.example'
36-
- 'docker-compose.yml'
36+
- 'compose.yml'
3737
# Any changes to local environment related files
3838
- 'tools/local-env/**'
3939
# These files configure npm and the task runner. Changes could affect the outcome.

.github/workflows/test-coverage.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
paths:
99
- '.github/workflows/test-coverage.yml'
1010
- '.github/workflows/reusable-phpunit-tests-v3.yml'
11-
- 'docker-compose.yml'
11+
- 'compose.yml'
1212
- 'phpunit.xml.dist'
1313
- 'tests/phpunit/multisite.xml'
1414
pull_request:
@@ -17,7 +17,7 @@ on:
1717
paths:
1818
- '.github/workflows/test-coverage.yml'
1919
- '.github/workflows/reusable-phpunit-tests-v3.yml'
20-
- 'docker-compose.yml'
20+
- 'compose.yml'
2121
- 'phpunit.xml.dist'
2222
- 'tests/phpunit/multisite.xml'
2323
# Once daily at 00:00 UTC.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ wp-tests-config.php
103103
!/src/js/_enqueues/vendor
104104

105105
# Files for local environment config
106-
/docker-compose.override.yml
106+
/compose.override.yml
107107

108108
# Visual regression test diffs
109109
tests/visual-regression/specs/__snapshots__

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ 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 (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.
4141

4242
### Development Environment Commands
4343

44-
Ensure [Docker](https://www.docker.com/products/docker-desktop) is running before using these commands.
44+
Ensure either [Docker](https://www.docker.com/products/docker-desktop) or [Podman](https://podman-desktop.io/) are running before using these commands.
4545

4646
#### To start the development environment for the first time
4747

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

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.
100+
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.
101101

102102
```
103103
npm run test:coverage
@@ -109,7 +109,7 @@ The command will generate three coverage reports in HTML, PHP, and text formats,
109109

110110
#### To restart the development environment
111111

112-
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:
112+
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:
113113

114114
```
115115
npm run env:restart
@@ -133,20 +133,20 @@ npm run env:start
133133

134134
#### Resetting the development environment
135135

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

138138
```
139139
npm run env:reset
140140
```
141141

142142
### Apple Silicon machines and old MySQL/MariaDB versions
143143

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

146146
- MySQL versions 5.7 and earlier
147147
- MariaDB 5.5
148148

149-
When using these versions on an Apple Silicon machine, you must create a `docker-compose.override.yml` file with the following contents:
149+
When using these versions on an Apple Silicon machine, you must create a `compose.override.yml` file with the following contents:
150150

151151
```
152152
services:
@@ -155,7 +155,7 @@ services:
155155
platform: linux/amd64
156156
```
157157

158-
Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in Docker needs to be disabled for this workaround.
158+
Additionally, the "Use Rosetta for x86/AMD64 emulation on Apple Silicon" setting in containers needs to be disabled for this workaround.
159159

160160
## Credentials
161161

docker-compose.yml renamed to compose.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ services:
44
# The web server container.
55
##
66
wordpress-develop:
7-
image: nginx:alpine
7+
image: docker.io/nginx:alpine
88

99
networks:
1010
- wpdevnet
@@ -32,7 +32,7 @@ services:
3232
# The PHP container.
3333
##
3434
php:
35-
image: wordpressdevelop/php:${LOCAL_PHP-latest}
35+
image: docker.io/wordpressdevelop/php:${LOCAL_PHP-latest}
3636

3737
networks:
3838
- wpdevnet
@@ -64,7 +64,7 @@ services:
6464
# The MySQL container.
6565
##
6666
mysql:
67-
image: ${LOCAL_DB_TYPE-mysql}:${LOCAL_DB_VERSION-latest}
67+
image: docker.io/${LOCAL_DB_TYPE-mysql}:${LOCAL_DB_VERSION-latest}
6868

6969
networks:
7070
- wpdevnet
@@ -95,7 +95,7 @@ services:
9595
# The WP CLI container.
9696
##
9797
cli:
98-
image: wordpressdevelop/cli:${LOCAL_PHP-latest}
98+
image: docker.io/wordpressdevelop/cli:${LOCAL_PHP-latest}
9999

100100
networks:
101101
- wpdevnet
@@ -130,7 +130,7 @@ services:
130130
# The Memcached container.
131131
##
132132
memcached:
133-
image: memcached
133+
image: docker.io/memcached:latest
134134

135135
networks:
136136
- wpdevnet

tools/local-env/scripts/utils.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ const local_env_utils = {
88
* Determines which Docker compose files are required to properly configure the local environment given the
99
* specified PHP version, database type, and database version.
1010
*
11-
* By default, only the standard docker-compose.yml file will be used.
11+
* By default, only the standard compose.yml file will be used.
1212
*
1313
* When PHP 7.2 or 7.3 is used in combination with MySQL 8.4, an override file will also be returned to ensure
1414
* that the mysql_native_password plugin authentication plugin is on and available for use.
1515
*
1616
* @return {string[]} Compose files.
1717
*/
1818
get_compose_files: function() {
19-
const composeFiles = [ 'docker-compose.yml' ];
19+
const composeFiles = [ 'compose.yml' ];
2020

21-
if ( existsSync( 'docker-compose.override.yml' ) ) {
22-
composeFiles.push( 'docker-compose.override.yml' );
21+
if ( existsSync( 'compose.override.yml' ) ) {
22+
composeFiles.push( 'compose.override.yml' );
2323
}
2424

2525
if ( process.env.LOCAL_DB_TYPE !== 'mysql' ) {

0 commit comments

Comments
 (0)