This is an automated email from the ASF dual-hosted git repository. cmarcum pushed a commit to branch task/geb-testcontainers in repository https://gitbox.apache.org/repos/asf/groovy-geb.git
commit d575ecfab1f9385b7f99d2080edc382bc7c4a164 Author: Carl Marcum <[email protected]> AuthorDate: Fri Feb 27 17:46:55 2026 -0500 add container building section. --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ integration/geb-testcontainers/README.md | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd97722d..4de32397 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,14 @@ To become a committer, you need to sign the [Apache Individual Contributor Agree ## Build Environment +Running the build requires a Java 11+ environment and the tests require a [compatible container runtime](https://java.testcontainers.org/supported_docker_environment/) to be installed, such as: + +- [Docker Desktop](https://www.docker.com/products/docker-desktop/) +- [OrbStack](https://orbstack.dev/) - macOS only +- [Rancher Desktop](https://rancherdesktop.io/) +- [podman desktop](https://podman-desktop.io/) +- [Colima](https://github.com/abiosoft/colima) - macOS and Linux + Geb builds with [Gradle](http://www.gradle.org/). You do not need to have Gradle installed to work with the Geb build as Gradle provides an executable wrapper that you use to drive the build. @@ -46,6 +54,21 @@ To publish Geb artifacts to your local Maven cache you would run: ./gradlew publishToMavenLocal +### Building in a Docker Container (Optional) + +A Dockerfile is provided to build the Geb Build image. + + docker build -t geb-build:latest . + +You can build Geb in a Docker container using the provided `build-in-docker.sh` script. + +From the root of the Geb project, run: + + ./build-in-docker.sh + +This will create an interactive shell in a Docker container. +Run the build with the full gradle wrapper commands. Just `exit` to leave the container. + ## Bootstrapping the build environment from a source distribution If you have cloned the source from the GitHub repo, you can skip this section. If instead diff --git a/integration/geb-testcontainers/README.md b/integration/geb-testcontainers/README.md index 973166f2..aa5a3935 100644 --- a/integration/geb-testcontainers/README.md +++ b/integration/geb-testcontainers/README.md @@ -41,7 +41,7 @@ For further reference please see the [Geb documentation](https://groovy.apache.o To use the library, add the following dependencies to your `build.gradle` file (adjust for the source set you're using it in, e.g., testImplementation or integrationTestImplementation.): ```groovy dependencies { - implementation "net.codebuilders:geb-container:<latest release>" + implementation "org.apache.groovy.geb:geb-testcontainers:<latest release>" } ```
