Skip to content

Commit 7691c46

Browse files
committed
docs: update readme and contributing files
1 parent d15de37 commit 7691c46

File tree

2 files changed

+12
-19
lines changed

2 files changed

+12
-19
lines changed

.github/CONTRIBUTING.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -245,40 +245,33 @@ This command will build the default image (specified by the `IMAGE_TEMPLATE` var
245245
To test a specific image variant, you can specify the `IMAGE_TEMPLATE` variable:
246246

247247
```bash
248-
make test IMAGE_TEMPLATE="8.3-fpm-alpine"
248+
make test IMAGE_TEMPLATE="k8s-alpine"
249249
```
250250

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.
252252

253253
### → Testing All Images
254254

255255
To test all supported image variants, run:
256256

257257
```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"
267260
```
268261

269262
### → Test Configuration
270263

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.
272265

273266
### → Writing and Updating Tests
274267

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:
276269

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.
278271
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
282275
* Any additional features or configurations specific to your changes
283276

284277
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
293286

294287
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.
295288

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.
297290

298291
<br>
299292

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ You can run tests using the following commands:
291291
make test IMAGE_TEMPLATE="k8s-alpine"
292292
```
293293

294-
Replace `8.3-fpm-alpine` with your desired PHP version, type, and OS.
294+
Replace `k8s-alpine` with your desired image type, and OS.
295295

296296
- Test all images:
297297

0 commit comments

Comments
 (0)