Skip to content

Commit 22050c0

Browse files
committed
docs: Add a migration guide section for 0.11+
1 parent 2f57e5d commit 22050c0

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -250,29 +250,37 @@ bukkit {
250250

251251
## Migration Guide
252252

253-
### Upgrade from 0.8.x
253+
### Upgrade from 0.10.x
254254

255-
1. Update gradle to 6.6 or newer:
256-
```shell
257-
$ ./gradlew wrapper --gradle-version 6.7.1
258-
```
259-
1. Use syntax `.set` in `bukkit.meta` instead of `=`:
255+
1. Update Gradle to 8.0 or newer (the latest version is recommended):
256+
```shell
257+
./gradlew wrapper --gradle-version 8.13
258+
```
259+
260+
2. Replace deprecated and removed APIs:
260261
```diff
261262
bukkit {
262-
meta {
263-
- desctiption = "My plugin's description"
264-
+ description.set("My plugin's description")
263+
- meta {
264+
+ plugin {
265+
name = "MyPlugin"
266+
- url = "https://example.com/"
267+
+ website = "https://example.com/"
265268
}
266269
}
267-
```
270+
```
271+
272+
3. If you have `plugin.yml`, move it's content to `bukkit.plugin { ... }` block
273+
274+
### Upgrade from 0.8.x
275+
268276
1. Use `bukkit.apiVersion` instead of `bukkit.version`:
269277
```diff
270278
bukkit {
271279
- version = "1.16.4"
272280
+ apiVersion = "1.16.4"
273281
}
274282
```
275-
1. Use `build.server` block instead of `build.run`:
283+
2. Use `build.server` block instead of `build.run`:
276284
```diff
277285
bukkit {
278286
- run {
@@ -281,7 +289,7 @@ bukkit {
281289
}
282290
}
283291
```
284-
1. Update arguments assignment syntax:
292+
3. Update arguments assignment syntax:
285293
```diff
286294
bukkit {
287295
server {
@@ -291,7 +299,7 @@ bukkit {
291299
}
292300
}
293301
```
294-
1. Replace removed APIs:
302+
4. Replace removed APIs:
295303
```diff
296304
repositories {
297305
- destroystokyo()
@@ -306,8 +314,8 @@ bukkit {
306314
+ compileOnly(spigot())
307315
}
308316
```
309-
1. Remove `q` and `qq` functions calls in `meta { ... }`
310-
1. Check generated plugin.yml contents after build.
317+
5. Remove `q` and `qq` functions calls in `meta { ... }`
318+
6. Check generated plugin.yml contents after build.
311319

312320
If there are any problems, [create an issue][issue].
313321

0 commit comments

Comments
 (0)