From 7b273affe3561522869504368bc48444ef127432 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=87=91=E6=88=9F?= <jinji.lf@alibaba-inc.com>
Date: Sat, 28 Nov 2020 19:52:20 +0800
Subject: [PATCH] testable-agent dependence is required in order to have agent
 jar downloaded

---
 .gitignore                         | 14 +++++++++-----
 demo/java-demo/pom.xml             |  6 ++++++
 demo/kotlin-demo/pom.xml           |  6 ++++++
 docs/zh-cn/doc/setup.md            | 14 +++++++++++---
 docs/zh-cn/doc/use-maven-plugin.md |  2 +-
 5 files changed, 33 insertions(+), 9 deletions(-)

diff --git a/.gitignore b/.gitignore
index 52869b1..fde5df2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,10 +1,9 @@
 # maven ignore
 target/
-*.jar
-*.war
-*.zip
-*.tar
-*.tar.gz
+
+# gradle ignore
+build/
+.gradle/
 
 # eclipse ignore
 .settings/
@@ -34,3 +33,8 @@ Thumbs.db
 
 # others
 note/
+*.jar
+*.war
+*.zip
+*.tar
+*.tar.gz
diff --git a/demo/java-demo/pom.xml b/demo/java-demo/pom.xml
index ded34aa..0b4c455 100644
--- a/demo/java-demo/pom.xml
+++ b/demo/java-demo/pom.xml
@@ -21,6 +21,12 @@
             <version>${testable.version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.alibaba.testable</groupId>
+            <artifactId>testable-agent</artifactId>
+            <version>${testable.version}</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
diff --git a/demo/kotlin-demo/pom.xml b/demo/kotlin-demo/pom.xml
index 6d692e7..be04be7 100644
--- a/demo/kotlin-demo/pom.xml
+++ b/demo/kotlin-demo/pom.xml
@@ -34,6 +34,12 @@
 			<version>${testable.version}</version>
 			<scope>provided</scope>
 		</dependency>
+		<dependency>
+			<groupId>com.alibaba.testable</groupId>
+			<artifactId>testable-agent</artifactId>
+			<version>${testable.version}</version>
+			<scope>provided</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter-api</artifactId>
diff --git a/docs/zh-cn/doc/setup.md b/docs/zh-cn/doc/setup.md
index f4bc046..7d025e9 100644
--- a/docs/zh-cn/doc/setup.md
+++ b/docs/zh-cn/doc/setup.md
@@ -19,7 +19,7 @@
 </properties>
 ```
 
-在`dependencies`列表添加`testable-processor`依赖：
+在`dependencies`列表添加TestableMock依赖：
 
 ```xml
 <dependencies>
@@ -29,6 +29,12 @@
         <version>${testable.version}</version>
         <scope>provided</scope>
     </dependency>
+    <dependency>
+        <groupId>com.alibaba.testable</groupId>
+        <artifactId>testable-agent</artifactId>
+        <version>${testable.version}</version>
+        <scope>provided</scope>
+    </dependency>
 </dependencies>
 ```
 
@@ -56,11 +62,13 @@
 
 ## 在Gradle项目中使用
 
-在`build.gradle`文件中添加`testable-processor`依赖：
+在`build.gradle`文件中添加TestableMock依赖：
 
 ```groovy
 dependencies {
-    testCompile('com.alibaba.testable:testable-processor:0.3.1')
+    testImplementation('com.alibaba.testable:testable-processor:0.3.1')
+    testAnnotationProcessor('com.alibaba.testable:testable-processor:0.3.1')
+    testRuntimeOnly('com.alibaba.testable:testable-agent:0.3.1')
 }
 ```
 
diff --git a/docs/zh-cn/doc/use-maven-plugin.md b/docs/zh-cn/doc/use-maven-plugin.md
index 1fa9542..de05fc9 100644
--- a/docs/zh-cn/doc/use-maven-plugin.md
+++ b/docs/zh-cn/doc/use-maven-plugin.md
@@ -19,7 +19,7 @@
 </plugin>
 ```
 
-> 当使用`testable-maven-plugin`插件时，应该移除`maven-surefire-plugin`插件上的TestableMock相关配置
+> 当使用`testable-maven-plugin`插件时，应该移除`maven-surefire-plugin`插件上的TestableMock相关配置，同时可以从项目的`pom.xml`文件中移除对`com.alibaba.testable:testable-agent`包的显示依赖
 
 `testable-maven-plugin`插件能够与Jacoco插件直接同时使用，无需额外适配，因此能使`pom.xml`文件编写起来更简单且美观。