@@ -3,49 +3,74 @@ package readme
3
3
import (
4
4
"fmt"
5
5
"os"
6
+ "strings"
6
7
"text/template"
7
8
)
8
9
9
10
const text = `# {{.}}
10
- {{.}}是一个微服务.<br/>
11
- 运行cmd脚本可查看使用方法.windows下将./cmd.sh换为cmd.bat<br/>
12
- ./cmd.sh pb 解析proto文件,生成打桩代码<br/>
13
- ./cmd.sh run 运行该程序<br/>
14
- ./cmd.sh build 编译该程序,会在根目录下生成一个可执行文件<br/>
15
- ./cmd.sh new 在该项目中创建一个新的子服务<br/>
16
- ./cmd.sh help 输出帮助信息<br/>
17
- ./cmd.sh kubernetes 增加或者更新kubernetes的配置<br/>
11
+ $$$
12
+ {{.}}是一个微服务.
13
+ 运行cmd脚本可查看使用方法.windows下将./cmd.sh换为cmd.bat
14
+ ./cmd.sh pb 解析proto文件,生成打桩代码
15
+ ./cmd.sh run 运行该程序
16
+ ./cmd.sh build 编译该程序,会在根目录下生成一个可执行文件
17
+ ./cmd.sh new 在该项目中创建一个新的子服务
18
+ ./cmd.sh help 输出帮助信息
19
+ ./cmd.sh kubernetes 增加或者更新kubernetes的配置
20
+ $$$
21
+
22
+
23
+ ## 环境变量
24
+ $$$
25
+ DISCOVERY_SERVER_GROUP 指定注册中心服务器所属的group名字
26
+ DISCOVERY_SERVER_NAME 指定注册中心服务器自身的名字
27
+ DISCOVERY_SERVER_PORT 指定注册中心服务器监听的端口
28
+ DISCOVERY_SERVER_VERIFY_DATA 连接注册中心服务器使用的校验数据
29
+ OLD_RPC_VERIFY_DATA 自身启动rpc服务时,当进行校验数据更新时才使用
30
+ RPC_VERIFY_DATA 自身启动rpc服务时,当前正在使用的最新的校验数据
31
+ OLD_PPROF_VERIFY_DATA web服务器使用pprof时才有效,当进行校验数据更新时才使用
32
+ PPROF_VERIFY_DATA web服务器使用pprof时才有效,当前正在使用的最新的校验数据
33
+ REMOTE_CONFIG 是否使用远程配置中心的配置[true/false]
34
+ RUN_ENV 当前运行环境,如:test,pre,prod
35
+ DEPLOY_ENV 部署环境,如:k8s,host
36
+ $$$
18
37
19
38
## 配置文件
20
- AppConfig.json该文件配置了该服务需要使用的业务配置,可热更新<br/>
21
- SourceConfig.json该文件配置了该服务需要使用的资源配置,不热更新<br/>
39
+ $$$
40
+ AppConfig.json该文件配置了该服务需要使用的业务配置,可热更新
41
+ SourceConfig.json该文件配置了该服务需要使用的资源配置,不热更新
42
+ $$$
22
43
23
44
## 初始化git
24
- 在项目根目录下执行以下命令初始化git本地仓库<br/>
25
- git init<br/>
26
- git add .<br/>
27
- git commit -m "code generate"<br/>
28
- 在git远程服务器上创建仓库,然后执行以下命令,将本地仓库与远程仓库关联<br/>
29
- git remote add origin path/to/your/remote/repo<br/>
30
- git push -u origin master<br/>
45
+ $$$
46
+ 在项目根目录下执行以下命令初始化git本地仓库
47
+ git init
48
+ git add .
49
+ git commit -m "code generate"
50
+ 在git远程服务器上创建仓库,然后执行以下命令,将本地仓库与远程仓库关联
51
+ git remote add origin path/to/your/remote/repo
52
+ git push -u origin main
53
+ $$$
31
54
32
55
## 开发
33
- 切换到开发分支<br/>
34
- git checkout -b your/branch/name/recommend/to/use/feature/name<br/>
35
- 开发完成后先提交到开发分支<br/>
36
- git add .<br/>
37
- git commit -m "your/commit/to/this/code/change"<br/>
38
- 将代码推送到git远程服务器,执行下面命令会要求set-upstream,直接复制git输出的命令运行<br/>
39
- git push<br/>
40
- 登陆到git远程服务器前端页面,创建merge,将代码提交到master,等待review和审批(记得勾选删除开发分支选项)<br/>
41
- merge完成后在自己的本地仓库执行<br/>
42
- git checkout master<br/>
43
- git pull<br/>
44
- 以下为可选步骤,用于删除本地开发分支和本地远程分支<br/>
45
- git checkout master<br/>
46
- git pull<br/>
47
- git branch -D your/branch/name/recommend/to/use/feature/name<br/>
48
- git remote prune origin<br/>`
56
+ $$$
57
+ 切换到开发分支
58
+ git checkout -b your/branch/name/recommend/to/use/feature/name
59
+ 开发完成后先提交到开发分支
60
+ git add .
61
+ git commit -m "your/commit/to/this/code/change"
62
+ 将代码推送到git远程服务器,执行下面命令会要求set-upstream,直接复制git输出的命令运行
63
+ git push
64
+ 登陆到git远程服务器前端页面,创建merge,将代码提交到master,等待review和审批(记得勾选删除开发分支选项)
65
+ merge完成后在自己的本地仓库执行
66
+ git checkout main
67
+ git pull
68
+ 以下为可选步骤,用于删除本地开发分支和本地远程分支
69
+ git checkout main
70
+ git pull
71
+ git branch -D your/branch/name/recommend/to/use/feature/name
72
+ git remote prune origin
73
+ $$$`
49
74
50
75
const path = "./"
51
76
const name = "README.md"
@@ -55,7 +80,7 @@ var file *os.File
55
80
56
81
func init () {
57
82
var e error
58
- tml , e = template .New ("api" ).Parse (text )
83
+ tml , e = template .New ("api" ).Parse (strings . Replace ( text , "$" , "`" , - 1 ) )
59
84
if e != nil {
60
85
panic (fmt .Sprintf ("create template for %s error:%s" , path + name , e ))
61
86
}
0 commit comments