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
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+11-18
Original file line number
Diff line number
Diff line change
@@ -245,40 +245,33 @@ This command will build the default image (specified by the `IMAGE_TEMPLATE` var
245
245
To test a specific image variant, you can specify the `IMAGE_TEMPLATE` variable:
246
246
247
247
```bash
248
-
make test IMAGE_TEMPLATE="8.3-fpm-alpine"
248
+
make test IMAGE_TEMPLATE="k8s-alpine"
249
249
```
250
250
251
-
Replace `8.3-fpm-alpine` with the desired PHP version, type, and OS.
251
+
Replace `k8s-alpine` with the desired image type, and OS.
252
252
253
253
### → Testing All Images
254
254
255
255
To test all supported image variants, run:
256
256
257
257
```bash
258
-
make test IMAGE_TEMPLATE="8.1-cli-alpine"
259
-
make test IMAGE_TEMPLATE="8.1-fpm-alpine"
260
-
make test IMAGE_TEMPLATE="8.1-supervisord-alpine"
261
-
make test IMAGE_TEMPLATE="8.2-cli-alpine"
262
-
make test IMAGE_TEMPLATE="8.2-fpm-alpine"
263
-
make test IMAGE_TEMPLATE="8.2-supervisord-alpine"
264
-
make test IMAGE_TEMPLATE="8.3-cli-alpine"
265
-
make test IMAGE_TEMPLATE="8.3-fpm-alpine"
266
-
make test IMAGE_TEMPLATE="8.3-supervisord-alpine"
258
+
make test IMAGE_TEMPLATE="k8s-alpine"
259
+
make test IMAGE_TEMPLATE="dev-alpine"
267
260
```
268
261
269
262
### → Test Configuration
270
263
271
-
The goss test configurations are generated from a Jinja2 template located at `src/Dockerfiles/base/goss.yaml.j2`. This template is used by Ansible to generate specific test configurations for each PHP version, type, and OS combination.
264
+
The goss test configurations are generated from a Jinja2 template located at `src/Dockerfiles/all/goss.yaml.j2`. This template is used by Ansible to generate specific test configurations for each image type, and OS combination.
272
265
273
266
### → Writing and Updating Tests
274
267
275
-
When contributing new features or making changes, please update the `src/Dockerfiles/base/goss.yaml.j2` file. This Jinja2 template defines the tests that will be generated for all image variants. When editing this file:
268
+
When contributing new features or making changes, please update the `src/Dockerfiles/all/goss.yaml.j2` file. This Jinja2 template defines the tests that will be generated for all image variants. When editing this file:
276
269
277
-
1. Use Jinja2 syntax for dynamic content that should change based on PHP version, type, or OS.
270
+
1. Use Jinja2 syntax for dynamic content that should change based on image type, or OS.
278
271
2. Ensure your tests cover:
279
-
* Presence and correctness of installed PHP extensions
280
-
* Proper configuration of PHP and its extensions
281
-
* Correct functioning of the PHP environment (CLI, FPM, or Supervisord)
272
+
* Presence and correctness of installed extensions
273
+
* Proper configuration of nginx and its extensions
274
+
* Correct functioning of the nginx environment
282
275
* Any additional features or configurations specific to your changes
283
276
284
277
After updating the template, regenerate the Dockerfiles and test configurations:
@@ -293,7 +286,7 @@ This command will use Ansible to process the updated template and generate new t
293
286
294
287
Our GitHub Actions workflow (`test.yml`) automatically runs these tests for each pull request and push to the main branch. Ensure that all tests pass in your local environment before submitting a pull request.
295
288
296
-
Remember, thorough testing is crucial for maintaining the reliability and consistency of our Docker images across different PHP versions and configurations. By updating the central Jinja2 template, we ensure consistency across all our image variants.
289
+
Remember, thorough testing is crucial for maintaining the reliability and consistency of our Docker images across different image types and configurations. By updating the central Jinja2 template, we ensure consistency across all our image variants.
0 commit comments