Skip to content

Commit f7260af

Browse files
author
Bryan Latten
committed
README: add release management
1 parent c5a20a2 commit f7260af

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,5 +215,26 @@ This will:
215215
- Validates a large file upload
216216
- Boots container with specific NewRelic configuration overrides
217217

218-
The test matrix is run automatically per pull request on Travis CI.
218+
### Release Management
219219

220+
Github actions provide the machinery for testing (ci.yaml) and producing tags distributed through Docker Hub (publish.yaml). Testing will confirm that `nginx` is able to serve content in various configurations, but also that it can terminate TLS with self-signed certificates. Once a tested and approved PR is merged, simply cutting a new semantically-versioned tag will generate the a matrix of tagged builds. See Container tag scheme above.
221+
222+
Platform support is available for multiple architectures:
223+
- `linux/amd64`: Ubuntu and Alpine variants
224+
- `linux/arm64`: Ubuntu variants-only
225+
226+
To add new variant based on a new Dockerfile, add an entry to `matrix.props` within `./github/workflows` YAML files.
227+
228+
### Github Actions: Simulation
229+
230+
docker-nginx uses Github Actions for CI/CD. Simulated workflows can be achieved locally with `act`. All commands must be executes from repository root.
231+
232+
Pre-reqs: tested on Mac
233+
1. [Docker Desktop](https://www.docker.com/products/docker-desktop)
234+
1. [act](https://github.com/nektos/act)
235+
236+
Pull request simulation: executes successfully, but only on ARM devices (ex. Apple M1). ARM emulation through QEMU on X64 machines does not implement the full kernel functionality required by nginx at this time.
237+
- `act pull_request`
238+
239+
Publish simulation: executes, but fails (intentionally) without credentials
240+
- `act`

0 commit comments

Comments
 (0)