Skip to content

Commit 2a046c9

Browse files
JorelAliJorelAli
committed
Update version numbers throughout the documentation to 10.0.0. Update update build script. Update info about Velocity to refer to non-snapshot builds
1 parent afe6335 commit 2a046c9

File tree

8 files changed

+38
-81
lines changed

8 files changed

+38
-81
lines changed

‎docs/en/dev-setup/annotations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The annotation system effectively needs to be added twice: Once for compilation
2222
<dependency>
2323
<groupId>dev.jorel</groupId>
2424
<artifactId>commandapi-annotations</artifactId>
25-
<version>9.7.0</version>
25+
<version>10.0.0</version>
2626
<scope>provided</scope>
2727
</dependency>
2828
</dependencies>
@@ -42,7 +42,7 @@ The annotation system effectively needs to be added twice: Once for compilation
4242
<path>
4343
<groupId>dev.jorel</groupId>
4444
<artifactId>commandapi-annotations</artifactId>
45-
<version>9.7.0</version>
45+
<version>10.0.0</version>
4646
</path>
4747
</annotationProcessorPaths>
4848
</configuration>
@@ -81,17 +81,17 @@ The annotation system effectively needs to be added twice: Once for compilation
8181

8282
```groovy
8383
dependencies {
84-
compileOnly "dev.jorel:commandapi-annotations:9.7.0"
85-
annotationProcessor "dev.jorel:commandapi-annotations:9.7.0"
84+
compileOnly "dev.jorel:commandapi-annotations:10.0.0"
85+
annotationProcessor "dev.jorel:commandapi-annotations:10.0.0"
8686
}
8787
```
8888
</div>
8989
<div class="kts">
9090

9191
```kotlin
9292
dependencies {
93-
compileOnly("dev.jorel:commandapi-annotations:9.7.0")
94-
annotationProcessor("dev.jorel:commandapi-annotations:9.7.0")
93+
compileOnly("dev.jorel:commandapi-annotations:10.0.0")
94+
annotationProcessor("dev.jorel:commandapi-annotations:10.0.0")
9595
}
9696
```
9797
</div>

‎docs/en/dev-setup/setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If you've never used a build system before, I highly recommend it! It makes it e
5151
<dependency>
5252
<groupId>dev.jorel</groupId>
5353
<artifactId>commandapi-bukkit-core</artifactId>
54-
<version>9.7.0</version>
54+
<version>10.0.0</version>
5555
<scope>provided</scope>
5656
</dependency>
5757
</dependencies>
@@ -90,7 +90,7 @@ If you've never used a build system before, I highly recommend it! It makes it e
9090

9191
```groovy
9292
dependencies {
93-
compileOnly "dev.jorel:commandapi-bukkit-core:9.7.0"
93+
compileOnly "dev.jorel:commandapi-bukkit-core:10.0.0"
9494
}
9595
```
9696

@@ -99,7 +99,7 @@ If you've never used a build system before, I highly recommend it! It makes it e
9999

100100
```kotlin
101101
dependencies {
102-
compileOnly("dev.jorel:commandapi-bukkit-core:9.7.0")
102+
compileOnly("dev.jorel:commandapi-bukkit-core:10.0.0")
103103
}
104104
```
105105

‎docs/en/dev-setup/shading.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Add the CommandAPI shade dependency:
113113
<dependency>
114114
<groupId>dev.jorel</groupId>
115115
<artifactId>commandapi-bukkit-shade</artifactId>
116-
<version>9.7.0</version>
116+
<version>10.0.0</version>
117117
</dependency>
118118
</dependencies>
119119
```
@@ -125,7 +125,7 @@ Add the CommandAPI shade dependency:
125125
<dependency>
126126
<groupId>dev.jorel</groupId>
127127
<artifactId>commandapi-bukkit-shade-mojang-mapped</artifactId>
128-
<version>9.7.0</version>
128+
<version>10.0.0</version>
129129
</dependency>
130130
</dependencies>
131131
```
@@ -221,15 +221,15 @@ Next, we declare our dependencies:
221221

222222
```groovy
223223
dependencies {
224-
implementation "dev.jorel:commandapi-bukkit-shade:9.7.0"
224+
implementation "dev.jorel:commandapi-bukkit-shade:10.0.0"
225225
}
226226
```
227227
</div>
228228
<div class="mojmap">
229229

230230
```groovy
231231
dependencies {
232-
implementation "dev.jorel:commandapi-bukkit-shade-mojang-mapped:9.7.0"
232+
implementation "dev.jorel:commandapi-bukkit-shade-mojang-mapped:10.0.0"
233233
}
234234
```
235235
</div>
@@ -239,15 +239,15 @@ dependencies {
239239

240240
```kotlin
241241
dependencies {
242-
implementation("dev.jorel:commandapi-bukkit-shade:9.7.0")
242+
implementation("dev.jorel:commandapi-bukkit-shade:10.0.0")
243243
}
244244
```
245245
</div>
246246
<div class="mojmap">
247247

248248
```kotlin
249249
dependencies {
250-
implementation("dev.jorel:commandapi-bukkit-shade-mojang-mapped:9.7.0")
250+
implementation("dev.jorel:commandapi-bukkit-shade-mojang-mapped:10.0.0")
251251
}
252252
```
253253
</div>

‎docs/en/kotlin-dsl/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To install the DSL, you need to add the `commandapi-bukkit-kotlin` dependency in
2626
<dependency>
2727
<groupId>dev.jorel</groupId>
2828
<artifactId>commandapi-bukkit-kotlin</artifactId>
29-
<version>9.7.0</version>
29+
<version>10.0.0</version>
3030
</dependency>
3131
</dependencies>
3232
```
@@ -106,7 +106,7 @@ Next, you need to add the dependency:
106106

107107
```groovy
108108
dependencies {
109-
implementation "dev.jorel:commandapi-bukkit-kotlin:9.7.0"
109+
implementation "dev.jorel:commandapi-bukkit-kotlin:10.0.0"
110110
}
111111
```
112112

@@ -115,7 +115,7 @@ dependencies {
115115

116116
```kotlin
117117
dependencies {
118-
implementation("dev.jorel:commandapi-bukkit-kotlin:9.7.0")
118+
implementation("dev.jorel:commandapi-bukkit-kotlin:10.0.0")
119119
}
120120
```
121121

‎docs/en/test/setup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ When you add the dependencies for MockBukkit and `commandapi-bukkit-test-toolkit
2929
<dependency>
3030
<groupId>dev.jorel</groupId>
3131
<artifactId>commandapi-bukkit-test-toolkit</artifactId>
32-
<version>9.7.0</version>
32+
<version>10.0.0</version>
3333
<scope>test</scope>
3434
</dependency>
3535

3636
<!-- May be the shade dependency and/or mojang-mapped -->
3737
<dependency>
3838
<groupId>dev.jorel</groupId>
3939
<artifactId>commandapi-bukkit-core</artifactId>
40-
<version>9.7.0</version>
40+
<version>10.0.0</version>
4141
<scope>provided</scope>
4242
</dependency>
4343

@@ -70,10 +70,10 @@ dependencies {
7070
// See https://github.com/MockBukkit/MockBukkit?tab=readme-ov-file#mag-usage for latest version
7171
testImplementation 'com.github.seeseemelk:MockBukkit-v1.21:3.128.0'
7272
73-
testImplementation 'dev.jorel:commandapi-bukkit-test-toolkit:9.7.0'
73+
testImplementation 'dev.jorel:commandapi-bukkit-test-toolkit:10.0.0'
7474
7575
// May be the shade dependency and/or mojang-mapped
76-
compileOnly 'dev.jorel:commandapi-bukkit-core:9.7.0'
76+
compileOnly 'dev.jorel:commandapi-bukkit-core:10.0.0'
7777
7878
// Can also be paper-api
7979
compileOnly 'org.spigotmc:spigot-api:1.21.1-R0.1-SNAPSHOT'
@@ -91,10 +91,10 @@ dependencies {
9191
// See https://github.com/MockBukkit/MockBukkit?tab=readme-ov-file#mag-usage for latest version
9292
testImplementation("com.github.seeseemelk:MockBukkit-v1.21:3.128.0")
9393

94-
testImplementation("dev.jorel:commandapi-bukkit-test-toolkit:9.7.0")
94+
testImplementation("dev.jorel:commandapi-bukkit-test-toolkit:10.0.0")
9595

9696
// May be the shade dependency and/or mojang-mapped
97-
compileOnly("dev.jorel:commandapi-bukkit-core:9.7.0")
97+
compileOnly("dev.jorel:commandapi-bukkit-core:10.0.0")
9898

9999
// Can also be paper-api
100100
compileOnly("org.spigotmc:spigot-api:1.21.1-R0.1-SNAPSHOT")

‎docs/en/velocity/intro.md

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,61 +8,15 @@ authors:
88

99
# Velocity
1010

11-
:::warning Developer's Note:
11+
:::info **Developer's Note:**
1212

13-
The CommandAPI hasn't been released for Velocity yet.
14-
We do, however, offer snapshot builds. This small section on Velocity will outline how to get the snapshot builds and what limitations the CommandAPI currently has on Velocity.
15-
16-
This page focuses on outlining how to set up the CommandAPI for Velocity. It expects that you are already familiar with how to set up a Velocity plugin.
13+
This section assumes you are already familiar with how to set up a Velocity plugin.
1714

1815
:::
1916

20-
## Adding the snapshot repository with Maven or Gradle
21-
22-
Because we do not have an official release yet, the snapshot builds are not published in the Maven Central repository. Instead you need to add our snapshot repository:
23-
24-
<div class="maven">
25-
26-
```xml
27-
<repositories>
28-
<repository>
29-
<id>oss.sonatype.org-snapshot</id>
30-
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
31-
</repository>
32-
</repositories>
33-
```
34-
35-
</div>
36-
<div class="gradle">
37-
38-
<div class="groovy">
39-
40-
```groovy
41-
repositories {
42-
maven {
43-
url = "https://s01.oss.sonatype.org/content/repositories/snapshots"
44-
}
45-
}
46-
```
47-
48-
</div>
49-
<div class="kts">
50-
51-
```kotlin
52-
repositories {
53-
maven {
54-
url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots")
55-
}
56-
}
57-
```
58-
59-
</div>
60-
61-
</div>
62-
6317
## Adding the dependency
6418

65-
As mentioned, Velocity can only be accessed with snapshot builds. These snapshot build versions are following standard semantic versioning and thus have the `-SNAPSHOT` suffix:
19+
Add the dependency to your list of dependencies in your build script:
6620

6721
<div class="maven">
6822

@@ -71,7 +25,7 @@ As mentioned, Velocity can only be accessed with snapshot builds. These snapshot
7125
<dependency>
7226
<groupId>dev.jorel</groupId>
7327
<artifactId>commandapi-velocity-shade</artifactId>
74-
<version>9.7.1-SNAPSHOT</version>
28+
<version>10.0.0</version>
7529
</dependency>
7630
</dependencies>
7731
```
@@ -83,7 +37,7 @@ As mentioned, Velocity can only be accessed with snapshot builds. These snapshot
8337

8438
```groovy
8539
dependencies {
86-
implementation "dev.jorel:commandapi-velocity-shade:9.7.1-SNAPSHOT"
40+
implementation "dev.jorel:commandapi-velocity-shade:10.0.0"
8741
}
8842
```
8943

@@ -92,7 +46,7 @@ dependencies {
9246

9347
```kotlin
9448
dependencies {
95-
implementation("dev.jorel:commandapi-velocity-shade:9.7.1-SNAPSHOT")
49+
implementation("dev.jorel:commandapi-velocity-shade:10.0.0")
9650
}
9751
```
9852

‎reference-code/gradle/libs.versions.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ com-mojang-authlib = "3.3.39"
77
com-mojang-brigadier = "1.0.17"
88
com-velocitypowered-velocity-api = "3.4.0-SNAPSHOT"
99
de-tr7zw-item-nbt-api = "2.11.1"
10-
dev-jorel-commandapi-annotations = "9.7.0"
11-
dev-jorel-commandapi-bukkit-core = "9.7.0"
12-
dev-jorel-commandapi-bukkit-kotlin = "9.7.0"
13-
dev-jorel-commandapi-bukkit-test-toolkit = "9.7.0"
14-
dev-jorel-commandapi-velocity-shade = "9.6.2-SNAPSHOT"
10+
dev-jorel-commandapi-annotations = "10.0.0"
11+
dev-jorel-commandapi-bukkit-core = "10.0.0"
12+
dev-jorel-commandapi-bukkit-kotlin = "10.0.0"
13+
dev-jorel-commandapi-bukkit-test-toolkit = "10.0.0"
14+
dev-jorel-commandapi-velocity-shade = "10.0.0"
1515
io-papermc-paper-paper-api = "1.21-R0.1-SNAPSHOT"
1616
net-kyori-adventure-platform-bukkit = "4.2.0"
1717
org-jetbrains-kotlin-kotlin-stdlib = "2.0.0"

‎update.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ sed -i "s/dev-jorel-commandapi-annotations = \"$oldVer\"/dev-jorel-commandapi-an
99
sed -i "s/dev-jorel-commandapi-bukkit-core = \"$oldVer\"/dev-jorel-commandapi-bukkit-core = \"$newVer\"/" reference-code/gradle/libs.versions.toml
1010
sed -i "s/dev-jorel-commandapi-bukkit-kotlin = \"$oldVer\"/dev-jorel-commandapi-bukkit-kotlin = \"$newVer\"/" reference-code/gradle/libs.versions.toml
1111
sed -i "s/dev-jorel-commandapi-bukkit-test-toolkit = \"$oldVer\"/dev-jorel-commandapi-bukkit-test-toolkit = \"$newVer\"/" reference-code/gradle/libs.versions.toml
12+
sed -i "s/dev-jorel-commandapi-velocity-shade = \"$oldVer\"/dev-jorel-commandapi-velocity-shade = \"$newVer\"/" reference-code/gradle/libs.versions.toml
1213

1314
# Update CommandAPI version in documentation files (Maven)
1415
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/dev-setup/annotations.md
1516
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/dev-setup/setup.md
1617
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/dev-setup/shading.md
1718
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/kotlin-dsl/intro.md
1819
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/test/setup.md
20+
sed -i "s/<version>$oldVer<\/version>/<version>$newVer<\/version>/" docs/en/velocity/intro.md
1921

2022
# Update CommandAPI version in documentation files (Gradle)
2123
sed -i "s/dev.jorel:commandapi-annotations:$oldVer/dev.jorel:commandapi-annotations:$newVer/" docs/en/dev-setup/annotations.md
@@ -25,6 +27,7 @@ sed -i "s/dev.jorel:commandapi-bukkit-shade-mojang-mapped:$oldVer/dev.jorel:comm
2527
sed -i "s/dev.jorel:commandapi-bukkit-kotlin:$oldVer/dev.jorel:commandapi-bukkit-kotlin:$newVer/" docs/en/kotlin-dsl/intro.md
2628
sed -i "s/dev.jorel:commandapi-bukkit-test-toolkit:$oldVer/dev.jorel:commandapi-bukkit-test-toolkit:$newVer/" docs/en/test/setup.md
2729
sed -i "s/dev.jorel:commandapi-bukkit-core:$oldVer/dev.jorel:commandapi-bukkit-core:$newVer/" docs/en/test/setup.md
30+
sed -i "s/dev.jorel:commandapi-velocity-shade:$oldVer/dev.jorel:commandapi-velocity-shade:$newVer/" docs/en/velocity/intro.md
2831

2932
# Possible manual updates
3033
echo "These may have to be updated manually:"

0 commit comments

Comments
 (0)