diff --git a/.gitignore b/.gitignore index cff626a..12fab46 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,5 @@ go.work .idea + +*mise*.toml \ No newline at end of file diff --git a/README.md b/README.md index 8c3e4d4..1366cb9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ + + +## 一、简单使用 + ### struct 标签 ``` @@ -110,5 +114,107 @@ func QueryAll(db *sql.DB)([]*User, error) { +## 二、嵌入其他项目调试 + + +### 源码集成调试 + +例如 想要在 UserProject 中进行调试 + +我们可以使用 go wrok 来集成 +现在 tdengine-mapper-go 和 UserProject 位于同一个目录 + +```text +cd UserProject +go work init +go work add . +go work add ../tdengine-mapper-go +``` +这样将会得到一个 go.work 文件 +```text +go 1.24.10 + +use ( + . + ../tdengine-mapper-go +) +``` +接下来 就可以直接在 UserProject 修改 tdengine-mapper-go中的源码了,当然在 tdengine-mapper-go 项目中直接修改也是可以的 + +#### 善后 +调试完成后,在 tdengine-mapper-go 将代码提交 +删除 UserProject 中的 go.work 文件 + + + +## 三、打标签提交 + +在其他项目中使用,实际上拉去的是 tdengine-mapper-go 标签版本,也就是说当我们完成之后,只是提交了 master 分支还不够,必须要将代码打上版本标签才然后推送出去,别人才能拉去到项目。 + +现在在假设你已经完成了代码的提交。 + +**git tag 操作** + +```bash +# 查看现有 tag +git tag # 展示所有tag +git tag -n # 展示tag和提交信息 +git show 标签名 # 查看某个 tag + + +# 创建 tag +git tag -a '版本号' -m '提交信息' # 打标签 +git tag -am '提交信息' 版本号 + +# tag 重命名 +git tag 老标签名 新标签名 +git tag -d 老标签名 + +# 推送 tag +git push origin 标签名 # 推送单个 tag +git push origin --tags # 推送全部 tag + +# 删除 tag +git tag -d 标签名 # 本地删除 tag +git push origin --delete 标签名 # 远程删除 tag + +# 检出 tag +git checkout -b 分支名称 标签名 +git checkout 标签名 +``` + + + +开始操作 + +```bash +// 先看下现在已经拥有的tag标签 +$ git tag +v0.0.1 v0.0.2 v0.0.3 v0.0.4 v0.0.5 v0.0.6 v0.0.7 v0.0.8 v0.0.9 v0.1.0 + +// 命名新的tag标签 并写上标签的 说明 +// 比如提交内容是这样的: +// 1. 补充了 readme.md 上的调试说明 +// 2. 修复了空指针的 BUG +$ git tag -a 'v0.1.1' -m "1. 补充了 readme.md 上的调试说明 +2. 修复了空指针的 BUG" + + +// 验证 查看 tag 信息 +git show v0.1.1 + + +// 然后推送到服务器 +$ git push origin v0.1.1 +``` + + + + + + + + +