Skip to content

Commit

Permalink
chore: update halo config block
Browse files Browse the repository at this point in the history
  • Loading branch information
guqing committed Oct 28, 2024
1 parent b0c5f9f commit 8d3eb70
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 24 deletions.
18 changes: 6 additions & 12 deletions docs/developer-guide/plugin/basics/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,17 @@ API 文档:http://localhost:8090/swagger-ui.html
=======================================================================
```

然后改动了某行代码需要使其生效,可以继续保持 `haloServer` 的运行,然后执行
修改代码后,无需停止服务,只需执行

```shell
./gradlew reloadPlugin
./gradlew reload
```

来时新的改动应用到现有服务上。

但如果你使用的 `watch` 任务启动插件则不需要执行 `reloadPlugin` 任务,它会监听文件的改动自动重载插件。
即可应用改动。如果使用 watch 任务启动插件,则不需要执行 `reload`,它会自动监听并重载插件。

## 配置

`build.gradle` 文件中作出配置可以更改 `devtools` 的行为
可通过 `build.gradle` 文件中的 `halo {}` 块自定义 Devtools 启动 Halo 服务必要配置,示例如下

```groovy
halo {
Expand All @@ -76,8 +74,6 @@ halo {
}
```

`halo {}` 这个配置对象下面用于配置 Halo 服务器的一些信息,所有配置的默认值如上所示,你可以直接使用默认值而不进行任何配置。

- `version`:表示要使用的 Halo 版本,随着插件 API 的更新你可能需要更高的 Halo 版本来运行插件,可自行更改。
- `superAdminUsername`: Halo 的超级管理员用户名,当你启动插件时会自动根据此配置和 `superAdminPassword` 为你初始化 Halo 的超级管理员账户。
- `superAdminPassword`:Halo 的超级管理员用户密码。
Expand Down Expand Up @@ -167,11 +163,9 @@ halo {
./gradlew reload
```

此任务用于重新加载当前正在开发的插件,如果你修改了插件的代码,可以通过此任务使更改生效。

此任务会将插件项目重新打包并重新加载到 Halo 服务中。
此任务用于重新加载当前正在开发的插件,修改代码后执行此任务以应用更改。

它依赖于以下三项配置,根据配置请求 Halo 服务的 API 来重新加载插件
该任务基于以下配置调用 Halo API 重新加载插件

```groovy
halo {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,17 @@ API 文档:http://localhost:8090/swagger-ui.html
=======================================================================
```

然后改动了某行代码需要使其生效,可以继续保持 `haloServer` 的运行,然后执行
修改代码后,无需停止服务,只需执行

```shell
./gradlew reloadPlugin
./gradlew reload
```

来时新的改动应用到现有服务上。

但如果你使用的 `watch` 任务启动插件则不需要执行 `reloadPlugin` 任务,它会监听文件的改动自动重载插件。
即可应用改动。如果使用 watch 任务启动插件,则不需要执行 `reload`,它会自动监听并重载插件。

## 配置

`build.gradle` 文件中作出配置可以更改 `devtools` 的行为
可通过 `build.gradle` 文件中的 `halo {}` 块自定义 Devtools 启动 Halo 服务必要配置,示例如下

```groovy
halo {
Expand All @@ -76,8 +74,6 @@ halo {
}
```

`halo {}` 这个配置对象下面用于配置 Halo 服务器的一些信息,所有配置的默认值如上所示,你可以直接使用默认值而不进行任何配置。

- `version`:表示要使用的 Halo 版本,随着插件 API 的更新你可能需要更高的 Halo 版本来运行插件,可自行更改。
- `superAdminUsername`: Halo 的超级管理员用户名,当你启动插件时会自动根据此配置和 `superAdminPassword` 为你初始化 Halo 的超级管理员账户。
- `superAdminPassword`:Halo 的超级管理员用户密码。
Expand Down Expand Up @@ -167,11 +163,9 @@ halo {
./gradlew reload
```

此任务用于重新加载当前正在开发的插件,如果你修改了插件的代码,可以通过此任务使更改生效。

此任务会将插件项目重新打包并重新加载到 Halo 服务中。
此任务用于重新加载当前正在开发的插件,修改代码后执行此任务以应用更改。

它依赖于以下三项配置,根据配置请求 Halo 服务的 API 来重新加载插件
该任务基于以下配置调用 Halo API 重新加载插件

```groovy
halo {
Expand Down

0 comments on commit 8d3eb70

Please sign in to comment.