Skip to content

Commit a704ff5

Browse files
committed
update doc
1 parent 5b6e7bc commit a704ff5

File tree

10 files changed

+51
-11
lines changed

10 files changed

+51
-11
lines changed

client/public/index.html

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
Learn how to configure a non-root public URL by running `npm run build`.
1616
-->
1717
<title>Hitchhiker API</title>
18+
<script>
19+
window.hkr_version = 'v0.14';
20+
</script>
1821
</head>
1922

2023
<body>

cn/change_log.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
#### 0.14 2018-07-29
2+
3+
**Features:**
4+
5+
* \#95 支持接口文档功能
6+
* \#230 改成编辑器性能
7+
* \#231 Schedule里的setting选项增加:1. 完成后或当失败后发送邮件, 2. 仅发送失败case或发送所有case。去掉环境变量里的 `HITCHHIKER_SCHEDULE_MAILFORFAIL`
8+
注意:这是一个破坏性改动,如果以前有设置过环境变量:`HITCHHIKER_SCHEDULE_MAILFORFAIL`,需要给具体的schedule重新设置。以前是所有统一设置,现在是每个schedule可以自己设置自己的。
9+
* \#232 给Parameters里的OneByOne增加识别数组的功能,以前只支持对象,现在支持把[{a: 1, b:2}, {a:3, b:4}]识别成两个case。
10+
* \#234 支持导出schedule结果到cls。
11+
12+
**Bugs:**
13+
14+
* \#214 开启密码加密后,刷新浏览器后丢掉session
15+
* \#216 项目邀请邮件发送失败
16+
* \#219 URL传参值错误
17+
* \#226 URL encode时对参数中+号的encode结果不正确,预期是%2B,实际将+号作为URI中的空格编码为%20
18+
19+
120
#### 0.13 2018-06-15
221

322
**Features:**

cn/installation/StepByStep.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
> 创建DB的脚本: CREATE DATABASE IF NOT EXISTS \`hitchhiker-prod\` default charset utf8 COLLATE utf8_general_ci;
2727
> 修改变量需要把`max_allowed_packet=200M`加到 my.ini 文件[mysqld] Section下,具体参考:[change max_allowed_packet](https://stackoverflow.com/questions/8062496/how-to-change-max-allowed-packet-size)
2828
29-
1. 下载安装包 [https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.13/Hitchhiker.zip);
29+
1. 下载安装包 [https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip](https://github.com/brookshi/Hitchhiker/releases/download/v0.14/Hitchhiker.zip);
3030
下载速度慢的可以去阿里云下载 http://hitchhiker.oss-cn-hongkong.aliyuncs.com/Hitchhiker.zip
3131

3232
2. 解压并在build目录下(即setup.js的目录)执行命令`node setup.js`(windows), `sudo node setup.js`(linux);

cn/installation/docker.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
docker使用的是docker-compose来安装,会自动下载两个image:hitchhiker和mysql,基本上按命令执行即可,如果需要配置,可以参考:[配置文件](configuration.md), 环境变量可以写到docker-compose.yml里
22

3-
国内用户请使用阿里云的镜像 hitchhiker-cn:registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13
3+
国内用户请使用阿里云的镜像 hitchhiker-cn:registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14
44

55
#### 参考下面命令,一步一步部署 (基于ubuntu,其他系统类似):
66
``` bash
@@ -21,7 +21,7 @@ curl -O https://raw.githubusercontent.com/brookshi/Hitchhiker/release/deploy/doc
2121

2222
# 编辑 docker-compose.yml, 把localhost换成你机器的局域网ip,如果是只有本机一个人用那就localhost也可以
2323
sudo vim docker-compose.yml
24-
# 修改完成后,保存退出 (国内用户改image地址:registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13, 以及写入环境变量配置hitchhiker以及mysql)
24+
# 修改完成后,保存退出 (国内用户改image地址:registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14, 以及写入环境变量配置hitchhiker以及mysql)
2525
...
2626

2727
# 执行docker-compose up安装镜像
@@ -36,7 +36,7 @@ curl http://ip:8080/
3636
version: '2'
3737
services:
3838
hitchhiker:
39-
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13
39+
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14
4040
container_name: hitchhiker
4141
environment:
4242
- HITCHHIKER_DB_HOST=hitchhiker-mysql
@@ -69,7 +69,7 @@ services:
6969
version: '2'
7070
services:
7171
hitchhiker:
72-
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13
72+
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14
7373
container_name: hitchhiker
7474
environment:
7575
- HITCHHIKER_DB_HOST=hitchhiker-mysql
@@ -100,7 +100,7 @@ services:
100100
version: '2'
101101
services:
102102
hitchhiker:
103-
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.13
103+
image: registry.cn-hangzhou.aliyuncs.com/brook/hitchhiker-cn:v0.14
104104
container_name: hitchhiker
105105
environment:
106106
- HITCHHIKER_DB_HOST=192.168.0.10

deploy/docker/hitchhiker/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: '2'
22
services:
33
hitchhiker:
4-
image: brookshi/hitchhiker:v0.13
4+
image: brookshi/hitchhiker:v0.14
55
container_name: hitchhiker
66
environment:
77
- HITCHHIKER_DB_HOST=hitchhiker-mysql

deploy/docker/hitchhiker_and_mysql/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: '2'
22
services:
33
hitchhiker:
4-
image: brookshi/hitchhiker:v0.13
4+
image: brookshi/hitchhiker:v0.14
55
container_name: hitchhiker
66
environment:
77
- HITCHHIKER_DB_HOST=hitchhiker-mysql

deploy/docker/push_docker.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export HITCHHIKER_VERSION="v0.13"
1+
export HITCHHIKER_VERSION="v0.14"
22
sudo docker pull registry.us-east-1.aliyuncs.com/brook/hitchhiker:$HITCHHIKER_VERSION
33
sudo docker login --username=brookshi --password=$DOCKER_ID_PWD
44
sudo docker tag registry.us-east-1.aliyuncs.com/brook/hitchhiker:$HITCHHIKER_VERSION brookshi/hitchhiker:$HITCHHIKER_VERSION

en/change_log.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
#### 0.14 2018-07-29
2+
3+
**Features:**
4+
5+
* \#95 Display and download Api document.
6+
* \#230 Improve editor performance.
7+
* \#231 Add config field for sending mail include run results of all request after schedule finished. Remove env variable `HITCHHIKER_SCHEDULE_MAILFORFAIL`.
8+
* \#232 Support to define variable array like `[{a: 1, b:2}, {a:3, b:4}]` in parameters which include all variables' value already.
9+
* \#234 Export schedule result to cls.
10+
11+
**Bugs:**
12+
13+
* \#214 Lose session if opening db password encryption.
14+
* \#216 Cannot send E-Mails for inviting members.
15+
* \#219 URL query string error.
16+
* \#226 URL query string encode `+` to %20.
17+
18+
119
#### 0.13 2018-06-15
220

321
**Features:**

en/installation/StepByStep.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Dependence: nodejs 7.60+, recommend use LTS (8.9) and `mysql 5.7+` with json col
2424
> create DB: CREATE DATABASE IF NOT EXISTS \`hitchhiker-prod\` default charset utf8 COLLATE utf8_general_ci;
2525
> 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)
2626
27-
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);
27+
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);
2828

2929
2. Unzip and run command `node setup.js`(windows), `sudo node setup.js`(linux) in `build` folder;
3030

en/installation/docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you want to use another port, should replace all 8080.
77
version: '2'
88
services:
99
hitchhiker:
10-
image: brookshi/hitchhiker:v0.13
10+
image: brookshi/hitchhiker:v0.14
1111
container_name: hitchhiker
1212
environment:
1313
- HITCHHIKER_DB_HOST=hitchhiker-mysql

0 commit comments

Comments
 (0)