Update documented dependency versions and mention gradle dependencies

JorelAli · Oct 16, 2024 · 0da49f1 · 0da49f1
1 parent d7987b2
commit 0da49f1
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 49 deletions.
diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test-toolkit/pom.xml b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-test-toolkit/pom.xml
@@ -75,11 +75,11 @@
 
 		<!-- Passing this to dependents gets rid of a `SLF4J: No SLF4J providers were found` warning -->
 		<!-- https://stackoverflow.com/questions/54652836/found-slf4j-api-dependency-but-no-providers-were-found -->
-		<!-- This version matches the slf4j-api declared by MockBukkit-1.20 (not sure if other versions are needed) -->
+		<!-- This version matches the slf4j-api declared by our dependency on paper-api through MockBukkit-1.21 -->
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-nop</artifactId>
-			<version>1.8.0-beta4</version>
+			<version>2.0.9</version>
 			<scope>compile</scope>
 		</dependency>
 

diff --git a/docssrc/src/test_setup.md b/docssrc/src/test_setup.md
@@ -8,12 +8,13 @@ When you add the dependencies for MockBukkit and `commandapi-bukkit-test-toolkit
 
 <div class="multi-pre">
 
-```xml,Plugin_Dependency
+```xml,Maven
 <dependencies>
+    <!-- See https://github.com/MockBukkit/MockBukkit?tab=readme-ov-file#mag-usage for latest version -->
     <dependency>
         <groupId>com.github.seeseemelk</groupId>
-        <artifactId>MockBukkit-v1.20</artifactId>
-        <version>3.9.0</version>
+        <artifactId>MockBukkit-v1.21</artifactId>
+        <version>3.128.0</version>
         <scope>test</scope>
     </dependency>
 
@@ -24,20 +25,23 @@ When you add the dependencies for MockBukkit and `commandapi-bukkit-test-toolkit
         <scope>test</scope>
     </dependency>
 
+    <!-- May be the shade dependency and/or mojang-mapped -->
     <dependency>
         <groupId>dev.jorel</groupId>
         <artifactId>commandapi-bukkit-core</artifactId>
         <version>9.6.0-SNAPSHOT</version>
         <scope>provided</scope>
     </dependency>
 
+    <!-- Can also be paper-api -->
     <dependency>
         <groupId>org.spigotmc</groupId>
         <artifactId>spigot-api</artifactId>
-        <version>1.20.6-R0.1-SNAPSHOT</version>
+        <version>1.21.1-R0.1-SNAPSHOT</version>
         <scope>provided</scope>
     </dependency>
 
+    <!-- See https://junit.org/junit5/ for latest version -->
     <dependency>
         <groupId>org.junit.jupiter</groupId>
         <artifactId>junit-jupiter-engine</artifactId>
@@ -47,43 +51,41 @@ When you add the dependencies for MockBukkit and `commandapi-bukkit-test-toolkit
 </dependencies>
 ```
 
-```xml,Shading_CommandAPI
-<dependencies>
-    <dependency>
-        <groupId>com.github.seeseemelk</groupId>
-        <artifactId>MockBukkit-v1.20</artifactId>
-        <version>3.9.0</version>
-        <scope>test</scope>
-    </dependency>
 
-    <dependency>
-        <groupId>dev.jorel</groupId>
-        <artifactId>commandapi-bukkit-test-toolkit</artifactId>
-        <version>9.6.0-SNAPSHOT</version>
-        <scope>test</scope>
-    </dependency>
+```groovy,Gradle_(build.gradle)
+dependencies {
+	// See https://github.com/MockBukkit/MockBukkit?tab=readme-ov-file#mag-usage for latest version
+	testImplementation 'com.github.seeseemelk:MockBukkit-v1.21:3.128.0'
 
-    <dependency>
-        <groupId>dev.jorel</groupId>
-        <artifactId>commandapi-bukkit-shade</artifactId>
-        <version>9.6.0-SNAPSHOT</version>
-        <scope>compile</scope>
-    </dependency>
+	testImplementation 'dev.jorel.commandapi-bukkit-test-toolkit:9.6.0-SNAPSHOT'
 
-    <dependency>
-        <groupId>org.spigotmc</groupId>
-        <artifactId>spigot-api</artifactId>
-        <version>1.20.6-R0.1-SNAPSHOT</version>
-        <scope>provided</scope>
-    </dependency>
+	// May be the shade dependency and/or mojang-mapped
+	implementation 'dev.jorel:commandapi-bukkit-plugin:9.6.0-SNAPSHOT'
 
-    <dependency>
-        <groupId>org.junit.jupiter</groupId>
-        <artifactId>junit-jupiter-engine</artifactId>
-        <version>5.8.2</version>
-        <scope>test</scope>
-    </dependency>
-</dependencies>
+	// Can also be paper-api
+	implementation 'org.spigotmc:spigot-api:1.21.1-R0.1-SNAPSHOT'
+
+	// See https://junit.org/junit5/ for latest version
+	testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
+}
+```
+
+```kotlin,Kotlin_Gradle_(build.gradle.kts)
+dependencies {
+	// See https://github.com/MockBukkit/MockBukkit?tab=readme-ov-file#mag-usage for latest version
+	testImplementation('com.github.seeseemelk:MockBukkit-v1.21:3.128.0')
+
+	testImplementation('dev.jorel.commandapi-bukkit-test-toolkit:9.6.0-SNAPSHOT')
+
+	// May be the shade dependency and/or mojang-mapped
+	implementation('dev.jorel:commandapi-bukkit-plugin:9.6.0-SNAPSHOT')
+
+	// Can also be paper-api
+	implementation('org.spigotmc:spigot-api:1.21.1-R0.1-SNAPSHOT')
+
+	// See https://junit.org/junit5/ for latest version
+	testImplementation('org.junit.jupiter:junit-jupiter-engine:5.8.2')
+}
 ```
 
 </div>
diff --git a/examples/bukkit/automated-tests-shaded/README.md b/examples/bukkit/automated-tests-shaded/README.md
@@ -10,8 +10,8 @@ Key points:
 <dependencies>
 	<dependency>
 		<groupId>com.github.seeseemelk</groupId>
-		<artifactId>MockBukkit-v1.20</artifactId>
-		<version>3.9.0</version>
+		<artifactId>MockBukkit-v1.21</artifactId>
+		<version>3.128.0</version>
 		<scope>test</scope>
 	</dependency>
 
@@ -29,10 +29,11 @@ Key points:
 		<scope>compile</scope>
 	</dependency>
 
+	<!-- Can also be paper-api -->
 	<dependency>
 		<groupId>org.spigotmc</groupId>
 		<artifactId>spigot-api</artifactId>
-		<version>1.20.6-R0.1-SNAPSHOT</version>
+		<version>1.21.1-R0.1-SNAPSHOT</version>
 		<scope>provided</scope>
 	</dependency>
 

diff --git a/examples/bukkit/automated-tests-shaded/pom.xml b/examples/bukkit/automated-tests-shaded/pom.xml
@@ -22,8 +22,8 @@
 		<!-- Otherwise, MockBukkit can get pretty cranky -->
 		<dependency>
 			<groupId>com.github.seeseemelk</groupId>
-			<artifactId>MockBukkit-v1.20</artifactId>
-			<version>3.9.0</version>
+			<artifactId>MockBukkit-v1.21</artifactId>
+			<version>3.128.0</version>
 			<scope>test</scope>
 		</dependency>
 

diff --git a/examples/bukkit/automated-tests/README.md b/examples/bukkit/automated-tests/README.md
@@ -10,8 +10,8 @@ Key points:
 <dependencies>
 	<dependency>
 		<groupId>com.github.seeseemelk</groupId>
-		<artifactId>MockBukkit-v1.20</artifactId>
-		<version>3.9.0</version>
+		<artifactId>MockBukkit-v1.21</artifactId>
+		<version>3.128.0</version>
 		<scope>test</scope>
 	</dependency>
 
@@ -29,10 +29,11 @@ Key points:
 		<scope>provided</scope>
 	</dependency>
 
+	<!-- Can also be paper-api -->
 	<dependency>
 		<groupId>org.spigotmc</groupId>
 		<artifactId>spigot-api</artifactId>
-		<version>1.20.6-R0.1-SNAPSHOT</version>
+		<version>1.21.1-R0.1-SNAPSHOT</version>
 		<scope>provided</scope>
 	</dependency>
 

diff --git a/examples/bukkit/automated-tests/pom.xml b/examples/bukkit/automated-tests/pom.xml
@@ -22,8 +22,8 @@
 		<!-- Otherwise, MockBukkit can get pretty cranky -->
 		<dependency>
 			<groupId>com.github.seeseemelk</groupId>
-			<artifactId>MockBukkit-v1.20</artifactId>
-			<version>3.9.0</version>
+			<artifactId>MockBukkit-v1.21</artifactId>
+			<version>3.128.0</version>
 			<scope>test</scope>
 		</dependency>
 

diff --git a/update.sh b/update.sh
@@ -22,6 +22,8 @@ sed -i "s/dev\.jorel:commandapi-bukkit-core:$oldVer/dev\.jorel:commandapi-bukkit
 sed -i "s/dev\.jorel:commandapi-annotations:$oldVer/dev\.jorel:commandapi-annotations:$newVer/" docssrc/src/setup_annotations.md
 sed -i "s/dev\.jorel:commandapi-bukkit-kotlin:$oldVer/dev\.jorel:commandapi-bukkit-kotlin:$newVer/" docssrc/src/kotlinintro.md
 sed -i "s/dev\.jorel:commandapi-velocity-kotlin:$oldVer/dev\.jorel:commandapi-velocity-kotlin:$newVer/" docssrc/src/kotlinintro.md
+sed -i "s/dev\.jorel:commandapi-bukkit-plugin:$oldVer/dev\.jorel:commandapi-bukkit-test-toolkit:$newVer/" docssrc/src/test_setup.md
+sed -i "s/dev\.jorel:commandapi-bukkit-plugin:$oldVer/dev\.jorel:commandapi-bukkit-plugin:$newVer/" docssrc/src/test_setup.md
 
 # mdBook documentation
 sed -i "s/$oldVer/$newVer/" docssrc/book.toml