From 10eb7e8bc10b73b972aee763c27e89790f3d5212 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-Fran=C3=A7ois=20Greffier?=
 <jfgreffier@users.noreply.github.com>
Date: Tue, 15 Aug 2023 20:19:24 +0200
Subject: [PATCH] docs: Java Gradle installation (#26418)

Docs update to install Playwright as a dependency with Gradle, also
introduce how to run Playwright CLI

```bash
./gradlew playwright --args="help"
```

Fixes [#571](https://github.com/microsoft/playwright-java/issues/571)
---
 docs/src/test-runners-java.md | 92 +++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/docs/src/test-runners-java.md b/docs/src/test-runners-java.md
index 9daf09cf0f..05850b3460 100644
--- a/docs/src/test-runners-java.md
+++ b/docs/src/test-runners-java.md
@@ -186,3 +186,95 @@ junit.jupiter.execution.parallel.mode.classes.default = concurrent
 junit.jupiter.execution.parallel.config.strategy=dynamic
 junit.jupiter.execution.parallel.config.dynamic.factor=0.5
 ```
+
+### Using Gradle
+
+You can use a Gradle build configuration script, written in Groovy or Kotlin.
+
+<Tabs
+  defaultValue="gradle"
+  values={[
+    {label: 'build.gradle', value: 'gradle'},
+    {label: 'build.gradle.kts', value: 'gradle-kotlin'}
+  ]
+}>
+<TabItem value="gradle">
+
+```java
+plugins {
+  application
+  id 'java'
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation 'com.microsoft.playwright:playwright:%%VERSION%%'
+}
+
+application {
+  mainClass = 'org.example.App'
+}
+
+// Usage: ./gradlew playwright --args="help"
+task playwright(type: JavaExec) {
+  classpath sourceSets.test.runtimeClasspath
+  mainClass = 'com.microsoft.playwright.CLI'
+}
+
+test {
+  useJUnitPlatform()
+}
+```
+
+</TabItem>
+<TabItem value="gradle-kotlin">
+
+```java
+plugins {
+  application
+  id("java")
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation("com.microsoft.playwright:playwright:%%VERSION%%")
+}
+
+application {
+  mainClass.set("org.example.App")
+}
+
+// Usage: ./gradlew playwright --args="help"
+tasks.register<JavaExec>("playwright") {
+  classpath(sourceSets["test"].runtimeClasspath)
+  mainClass.set("com.microsoft.playwright.CLI")
+}
+
+tasks.test {
+  useJUnitPlatform()
+  testLogging {
+    events("passed", "skipped", "failed")
+  }
+}
+```
+
+</TabItem>
+</Tabs>
+
+Tests can then be launched as follows:
+
+```bash
+./gradlew run
+```
+
+Also, Playwright command line tools can be run with :
+
+```bash
+./gradlew playwright --args="help"
+```