From 4945e815ca9f1bb27c43ea169c7020042a04fc07 Mon Sep 17 00:00:00 2001 From: lijiahang Date: Wed, 15 Jun 2022 08:59:11 +0800 Subject: [PATCH] update docs. --- README.md | 1 + docs/README.md | 1 + docs/about/change-log.md | 15 +++++++++++++++ docs/about/roadmap.md | 8 ++++---- docs/about/update.md | 22 +++++++++++++++++++++- docs/advance/second-dev.md | 5 +++++ 6 files changed, 47 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 886a8867..49d6a93c 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ demo: http://101.43.254.243/ops/#/ 开发文档: https://lijiahangmax.gitee.io/orion-ops/#/advance/second-dev 操作手册: https://lijiahangmax.gitee.io/orion-ops/#/operator/machine 常见问题: https://lijiahangmax.gitee.io/orion-ops/#/quickstart/faq +通用模板: https://lijiahangmax.gitee.io/orion-ops/#/template/java-springboot-template roadmap: https://lijiahangmax.gitee.io/orion-ops/#/about/roadmap ## 技术栈 diff --git a/docs/README.md b/docs/README.md index 8e61f19e..918d2d67 100644 --- a/docs/README.md +++ b/docs/README.md @@ -57,6 +57,7 @@ demo: http://101.43.254.243/ops/#/ 开发文档: https://lijiahangmax.gitee.io/orion-ops/#/advance/second-dev 操作手册: https://lijiahangmax.gitee.io/orion-ops/#/operator/machine 常见问题: https://lijiahangmax.gitee.io/orion-ops/#/quickstart/faq +通用模板: https://lijiahangmax.gitee.io/orion-ops/#/template/java-springboot-template roadmap: https://lijiahangmax.gitee.io/orion-ops/#/about/roadmap ## 技术栈 diff --git a/docs/about/change-log.md b/docs/about/change-log.md index 4bd19791..78b7c0e6 100644 --- a/docs/about/change-log.md +++ b/docs/about/change-log.md @@ -1,3 +1,18 @@ +## 1.1.3 + +`2022-06-15` `refactor` + +🌈 添加 `swagger` api文档 +🌈 添加 日志面板上传日志文件 +🌈 日志面板页添加去除日志文件 `ANSI` 着色码工具 +🔨 重构前端代码 `枚举 $enum` +🔨 重构前端代码 `工具 $utils` +🔨 重构前端代码 `过滤器 $filters` +🐞 修复 导入机器后没有环境变量 +📈 此版本主要是重构及优化代码 + +[如何升级](/about/update.md?id=_113) + ## 1.1.2 `2022-06-03` `release` diff --git a/docs/about/roadmap.md b/docs/about/roadmap.md index fba5a624..6f6669eb 100644 --- a/docs/about/roadmap.md +++ b/docs/about/roadmap.md @@ -67,10 +67,9 @@ ## 开发中 ⏱ -* 添加 swagger -* 添加 应用配置, 应用流水线 以 yml 的形式查看和保存 -* 发布 webhook -* 前端枚举, 工具, antd模块化引用 代码重构 +* 构建成功 webhook +* 发布成功 webhook +* 流水线执行成功 webhook ## 未开始 ⏳ @@ -98,3 +97,4 @@ * ~~SFTP 拖拽移动~~ (实现过于复杂) * ~~选择 tag 构建~~ (工作量大没必要) +* ~~应用配置以 yml 的形式查看和保存~~ (命令中会有大量的 `\n` `'` `"` 不宜读) diff --git a/docs/about/update.md b/docs/about/update.md index c3f790fd..fee0dee6 100644 --- a/docs/about/update.md +++ b/docs/about/update.md @@ -1,4 +1,24 @@ -⚡ 注意: 应用不支持跨版本升级 +⚡ 注意: 应用不支持跨版本升级, 可以进行多次升级 + +## 1.1.3 + +> sql 脚本 + +```sql +ALTER TABLE `application_info` +MODIFY COLUMN `vcs_id` bigint(20) NULL DEFAULT NULL COMMENT '应用版本仓库id' AFTER `app_sort`; + +ALTER TABLE `application_build` +MODIFY COLUMN `vcs_id` bigint(20) NULL DEFAULT NULL COMMENT '应用版本仓库id' AFTER `commit_id`; + +ALTER TABLE `application_vcs` COMMENT = '应用版本仓库'; + +ALTER TABLE `application_release` COMMENT = '发布任务'; + +ALTER TABLE `application_release_machine` +MODIFY COLUMN `release_id` bigint(20) NULL DEFAULT NULL COMMENT '发布任务id' AFTER `id`, +COMMENT = '发布任务机器表'; +``` ## 1.1.2 diff --git a/docs/advance/second-dev.md b/docs/advance/second-dev.md index 07c2424b..4cef7582 100644 --- a/docs/advance/second-dev.md +++ b/docs/advance/second-dev.md @@ -57,6 +57,11 @@ 账号: `orionadmin` 密码: `orionadmin` +### swagger + +地址: http://127.0.0.1:9119/doc.html#/home +这个只有在 `dev` `local` 环境才可以访问 + ### 配置系统 登录后需要配置宿主机 SSH 信息, 本地调试阶段宿主机可以改为远程机器