From a704ff59a763b7d3eae587a2744ea19b72fec059 Mon Sep 17 00:00:00 2001 From: brookshi Date: Sun, 29 Jul 2018 23:30:32 +0800 Subject: [PATCH] update doc --- client/public/index.html | 3 +++ cn/change_log.md | 19 +++++++++++++++++++ cn/installation/StepByStep.md | 2 +- cn/installation/docker.md | 10 +++++----- deploy/docker/hitchhiker/docker-compose.yml | 2 +- .../hitchhiker_and_mysql/docker-compose.yml | 2 +- deploy/docker/push_docker.sh | 2 +- en/change_log.md | 18 ++++++++++++++++++ en/installation/StepByStep.md | 2 +- en/installation/docker.md | 2 +- 10 files changed, 51 insertions(+), 11 deletions(-) diff --git a/client/public/index.html b/client/public/index.html index bca99f2..479f970 100644 --- a/client/public/index.html +++ b/client/public/index.html @@ -15,6 +15,9 @@ Learn how to configure a non-root public URL by running `npm run build`. --> Hitchhiker API + diff --git a/cn/change_log.md b/cn/change_log.md index 2a26c11..c059ebc 100644 --- a/cn/change_log.md +++ b/cn/change_log.md @@ -1,3 +1,22 @@ +#### 0.14 2018-07-29 + +**Features:** + +* \#95 支持接口文档功能 +* \#230 改成编辑器性能 +* \#231 Schedule里的setting选项增加：1. 完成后或当失败后发送邮件， 2. 仅发送失败case或发送所有case。去掉环境变量里的 `HITCHHIKER_SCHEDULE_MAILFORFAIL`。 +注意：这是一个破坏性改动，如果以前有设置过环境变量：`HITCHHIKER_SCHEDULE_MAILFORFAIL`，需要给具体的schedule重新设置。以前是所有统一设置，现在是每个schedule可以自己设置自己的。 +* \#232 给Parameters里的OneByOne增加识别数组的功能，以前只支持对象，现在支持把[{a: 1, b:2}, {a:3, b:4}]识别成两个case。 +* \#234 支持导出schedule结果到cls。 + +**Bugs:** + +* \#214 开启密码加密后，刷新浏览器后丢掉session +* \#216 项目邀请邮件发送失败 +* \#219 URL传参值错误 +* \#226 URL encode时对参数中+号的encode结果不正确，预期是%2B，实际将+号作为URI中的空格编码为%20 + + #### 0.13 2018-06-15 **Features:** diff --git a/cn/installation/StepByStep.md b/cn/installation/StepByStep.md index 55c3458..d00a01d 100644 --- a/cn/installation/StepByStep.md +++ b/cn/installation/StepByStep.md @@ -26,7 +26,7 @@ > 创建DB的脚本: CREATE DATABASE IF NOT EXISTS \`hitchhiker-prod\` default charset utf8 COLLATE utf8_general_ci; > 修改变量需要把`max_allowed_packet=200M`加到 my.ini 文件[mysqld] Section下，具体参考：[change max_allowed_packet](https://stackoverflow.com/questions/8062496/how-to-change-max-allowed-packet-size) -1. 下载安装包 [https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip); +1. 下载安装包 [https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip); 下载速度慢的可以去阿里云下载 http://hitchhiker.oss-cn-hongkong.aliyuncs.com/Hitchhiker.zip 2. 解压并在build目录下（即setup.js的目录）执行命令`node setup.js`(windows), `sudo node setup.js`(linux); diff --git a/cn/installation/docker.md b/cn/installation/docker.md index e605a1f..66634a3 100644 --- a/cn/installation/docker.md +++ b/cn/installation/docker.md @@ -1,6 +1,6 @@ docker使用的是docker-compose来安装，会自动下载两个image：hitchhiker和mysql，基本上按命令执行即可，如果需要配置，可以参考：[配置文件](configuration.md), 环境变量可以写到docker-compose.yml里 -国内用户请使用阿里云的镜像 hitchhiker-cn：registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13 +国内用户请使用阿里云的镜像 hitchhiker-cn：registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14 #### 参考下面命令，一步一步部署 (基于ubuntu，其他系统类似): ``` bash @@ -21,7 +21,7 @@ curl -O https://raw.githubusercontent.com/brookshi/Hitchhiker/release/deploy/doc # 编辑 docker-compose.yml， 把localhost换成你机器的局域网ip，如果是只有本机一个人用那就localhost也可以 sudo vim docker-compose.yml -# 修改完成后，保存退出 (国内用户改image地址：registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13， 以及写入环境变量配置hitchhiker以及mysql) +# 修改完成后，保存退出 (国内用户改image地址：registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14， 以及写入环境变量配置hitchhiker以及mysql) ... # 执行docker-compose up安装镜像 @@ -36,7 +36,7 @@ curl http://ip:8080/ version: '2' services: hitchhiker: - image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13 + image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=hitchhiker-mysql @@ -69,7 +69,7 @@ services: version: '2' services: hitchhiker: - image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13 + image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=hitchhiker-mysql @@ -100,7 +100,7 @@ services: version: '2' services: hitchhiker: - image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13 + image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=192.168.0.10 diff --git a/deploy/docker/hitchhiker/docker-compose.yml b/deploy/docker/hitchhiker/docker-compose.yml index f09d82b..ea108d7 100644 --- a/deploy/docker/hitchhiker/docker-compose.yml +++ b/deploy/docker/hitchhiker/docker-compose.yml @@ -1,7 +1,7 @@ version: '2' services: hitchhiker: - image: brookshi/hitchhiker:v0.13 + image: brookshi/hitchhiker:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=hitchhiker-mysql diff --git a/deploy/docker/hitchhiker_and_mysql/docker-compose.yml b/deploy/docker/hitchhiker_and_mysql/docker-compose.yml index a47d3e7..c3c390f 100644 --- a/deploy/docker/hitchhiker_and_mysql/docker-compose.yml +++ b/deploy/docker/hitchhiker_and_mysql/docker-compose.yml @@ -1,7 +1,7 @@ version: '2' services: hitchhiker: - image: brookshi/hitchhiker:v0.13 + image: brookshi/hitchhiker:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=hitchhiker-mysql diff --git a/deploy/docker/push_docker.sh b/deploy/docker/push_docker.sh index 6870e5e..958a899 100644 --- a/deploy/docker/push_docker.sh +++ b/deploy/docker/push_docker.sh @@ -1,4 +1,4 @@ -export HITCHHIKER_VERSION="v0.13" +export HITCHHIKER_VERSION="v0.14" sudo docker pull registry.us-east-1.aliyuncs.com/brook/hitchhiker:$HITCHHIKER_VERSION sudo docker login --username=brookshi --password=$DOCKER_ID_PWD sudo docker tag registry.us-east-1.aliyuncs.com/brook/hitchhiker:$HITCHHIKER_VERSION brookshi/hitchhiker:$HITCHHIKER_VERSION diff --git a/en/change_log.md b/en/change_log.md index e05e299..1f06c0e 100644 --- a/en/change_log.md +++ b/en/change_log.md @@ -1,3 +1,21 @@ +#### 0.14 2018-07-29 + +**Features:** + +* \#95 Display and download Api document. +* \#230 Improve editor performance. +* \#231 Add config field for sending mail include run results of all request after schedule finished. Remove env variable `HITCHHIKER_SCHEDULE_MAILFORFAIL`. +* \#232 Support to define variable array like `[{a: 1, b:2}, {a:3, b:4}]` in parameters which include all variables' value already. +* \#234 Export schedule result to cls. + +**Bugs:** + +* \#214 Lose session if opening db password encryption. +* \#216 Cannot send E-Mails for inviting members. +* \#219 URL query string error. +* \#226 URL query string encode `+` to %20. + + #### 0.13 2018-06-15 **Features:** diff --git a/en/installation/StepByStep.md b/en/installation/StepByStep.md index 8be0825..575e61b 100644 --- a/en/installation/StepByStep.md +++ b/en/installation/StepByStep.md @@ -24,7 +24,7 @@ Dependence: nodejs 7.60+, recommend use LTS (8.9) and `mysql 5.7+` with json col > create DB: CREATE DATABASE IF NOT EXISTS \`hitchhiker-prod\` default charset utf8 COLLATE utf8_general_ci; > change variable: add `max_allowed_packet=200M` under [mysqld] section in /my.conf file, refer to：[change max_allowed_packet](https://stackoverflow.com/questions/8062496/how-to-change-max-allowed-packet-size) -1. Download app package from [https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip); +1. Download app package from [https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip); 2. Unzip and run command `node setup.js`(windows), `sudo node setup.js`(linux) in `build` folder; diff --git a/en/installation/docker.md b/en/installation/docker.md index ad10491..94660bf 100644 --- a/en/installation/docker.md +++ b/en/installation/docker.md @@ -7,7 +7,7 @@ If you want to use another port, should replace all 8080. version: '2' services: hitchhiker: - image: brookshi/hitchhiker:v0.13 + image: brookshi/hitchhiker:v0.14 container_name: hitchhiker environment: - HITCHHIKER_DB_HOST=hitchhiker-mysql