qshell 命令行用法变化很大，版本号却没有体现

[xen0n]

$ qshell -v
QShell/v2.1.8 (darwin; amd64; go1.9)
$ qshell --help
Usage of qshell:
  -c string
        account file path
  -d    debug mode
  -f string
        host file
  -h    show help
  -m    multi user mode
  -v    show version

vs:

$ ./qshell-darwin-x64-v2.4.0 --help

...

Flags:
  -C, --config string   config file (default is $HOME/.qshell.json)
  -d, --debug           debug mode
  -h, --help            help for qshell
  -L, --local           use current directory as config file path
  -v, --version         show version

Use "qshell [command] --help" for more information about a command.

好坑啊= =

[xen0n]

$ qshell rput --help
Usage: qshell rput <Bucket> <Key> <LocalFile> [<Overwrite>] [<MimeType>] [<UpHost>] [<FileType>]
  Resumable upload a local file

$ ./qshell-darwin-x64-v2.4.0 rput --help
Resumable upload a local file

Usage:
  qshell rput <Bucket> <Key> <LocalFile> [flags]

Flags:
  -T, --callback-host string   upload callback host
  -l, --callback-urls string   upload callback urls, separated by comma
  -h, --help                   help for rput
  -t, --mimetype string        file mime type
  -w, --overwrite              overwrite mode
  -s, --storage int            storage type
  -u, --up-host string         uphost
  -c, --worker int             worker count (default 16)

Global Flags:
  -C, --config string   config file (default is $HOME/.qshell.json)
  -d, --debug           debug mode
  -L, --local           use current directory as config file path
  -v, --version         show version

还不止一个地方变了，感觉整个都重写了一遍，为啥版本号不是 3.x...

[xen0n]

建议要么兼容旧的参数传递方式（几乎不可能），要么版本号好好起一下。。

[xen0n]

account.json 格式也变了 🌚🌚🌚🌚🌚🌚

[xushiwei]

感谢反馈。
这基本上算常识了，的确需要严格遵循。
我们考虑如何自动化地确保这事不会在发生。
Go team 给自己发明了一个自动化机制来检查版本兼容性，可以考虑借鉴过来。

[xushiwei]

https://github.com/golang/go/tree/master/api

[xen0n]

go 那一套机制是典型的 public API 兼容性检查，Android、glibc 都有类似的机制。

qshell 这种命令行用法，前期先用 e2e 测试覆盖就够了，起一个 Docker 容器或者 chroot（因为 qshell 的成品二进制是静态的所以 chroot 很方便）就可以。

[CarlJi]

这里分场景的:

1. 如果我们要保持兼容，那从设计开发意识上，就需要这么注意。同时，在配置上兼容性测试检查，确保不出非预期的情况。
2. 如果因实际情况不能兼容，应该在release 文档等地方，显著说明。

[CarlJi]

@xen0n 参考 #273 ，以后通过github release qshell版本会自动注入版本号。至于qshell的兼容性，后续我将会推动KODO产品经理做统一规划。所以该问题感觉可以先行关闭？

[xen0n]

刚看到= =

这样不太好吧，版本号变成 3.0.0，发个 changelog 承认错误（承认从 2.4.x 哪个版本开始命令行用法变化了，但没有 bump major version），然后写清楚 version policy（用 semver 的话，什么更改算作 bump major version，什么更改算作 bump minor version），这样才能达到一个负责任开源项目的标准

[xen0n]

具体 changelog 可以写 No changes compared to the previous version, just a major version bump to reflect the CLI compatibility breakage since v2.4.x. Also added versioning policy to prevent such issues in the future. 这样

[xushiwei]

同意雪瑞。
而且不只是这一个qshell的问题，我们要思考的是如何保证兼容性在机制上阻止人去破坏。
规格为先，规格是最重要的东西。我们需要有机制保证规格的延续性，这才是真正的质量保障。