diff --git a/README.md b/README.md index 7520ca6..84f576a 100644 --- a/README.md +++ b/README.md @@ -63,4 +63,5 @@ Documentation **Internals** -* [How Testing Works](docs/testing.md) \ No newline at end of file +* [How Testing Works](docs/testing.md) +* [Continuous Integration Notes](docs/ci.md) \ No newline at end of file diff --git a/docs/ci.md b/docs/ci.md new file mode 100644 index 0000000..3c38ad9 --- /dev/null +++ b/docs/ci.md @@ -0,0 +1,14 @@ +Continuous Integration Notes +---------------------------- + +Docker containers are registered in the registry that contain an environment for various PHP versions. At the very least +there should be two versions, one of the oldest version of PHP we're supporting and one for the newest. In a perfect world, +we'd also have an image for a Windows server using PHP to gain some CI test coverage with Windows style absolute paths. +However, getting PHP running on a Windows container proved to be too complicated for the value. Until such a time where +we can get one created (contributions welcome), testing on Windows will be done manually. + +The Dockerfiles used to create these images are contained in a different repository: +[ClassFinderTestContainers](https://gitlab.com/hpierce1102/ClassFinderTestContainers). + +The CI scripts themselves are stored here in `/ci/*`, with the config in `/gitlab-ci.yml`. +