Skip to content

Commit fd4e613

Browse files
authored
Add plugin migration documentation for Halo 2.23 (#561)
Fixes #560 ```release-note None ```
1 parent 5e19068 commit fd4e613

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/developer-guide/plugin/api-changelog.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,44 @@ description: 记录每一个版本的插件 API 变更记录,方便开发者
55

66
## 2.23.0
77

8+
### Spring Boot 依赖升级可能导致插件无法正常启动
9+
10+
在 2.23.0 中,我们升级了 Spring Boot 版本至 4.x,该版本包含一些破坏性更新,可能会导致插件无法正常启动,因此建议插件开发者尽快升级 Halo 依赖,`build.gradle` 修改示例如下:
11+
12+
```groovy
13+
repositories {
14+
// TODO Remove this repository once the new version is released
15+
maven {
16+
name = 'Central Portal Snapshots'
17+
url = 'https://central.sonatype.com/repository/maven-snapshots/'
18+
19+
// Only search this repository for the specific dependency
20+
content {
21+
includeGroupAndSubgroups('run.halo')
22+
}
23+
}
24+
mavenCentral()
25+
}
26+
27+
dependencies {
28+
// TODO Change to a released version once available
29+
implementation platform('run.halo.tools.platform:plugin:2.23.0-SNAPSHOT')
30+
}
31+
32+
halo {
33+
version = '2.23.0-beta.2'
34+
}
35+
```
36+
37+
`plugin.yaml` 中的 `spec.requires` 字段也需要提升至 `>=2.23.0`,示例如下:
38+
39+
```yaml
40+
spec:
41+
requires: ">=2.23.0"
42+
```
43+
44+
尝试构建并解决编译错误即可。如果使用了 Spring 相关的组件或者 API,请参考 [Spring Boot 4.x 的升级指南](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-4.0-Migration-Guide)进行适配。
45+
846
### 表单定义 > Iconify 表单类型新增 `sizing` 参数
947

1048
在 2.23.0 中,Iconify 表单类型默认不再显示图标大小选项,如果需要让用户设置图标大小,可以配置 `sizing` 参数,详细文档可查阅:[表单定义#Iconify](../../developer-guide/form-schema.md#iconify)

0 commit comments

Comments
 (0)