Skip to content

Latest commit

 

History

History
100 lines (81 loc) · 4.13 KB

DevSOP.md

File metadata and controls

100 lines (81 loc) · 4.13 KB
Raw

开发指引

发版规约

  1. 拉取 master 最新代码: git pull
  2. 从 master 检出 [版本分支]: git checkout -b v${x.y.z}
  3. 批量修改父子所有 pom.xml 中的 <version>: 版本号 +1， 末尾增加 -SNAPSHOT 快照标识
  4. push [版本分支] 到 Github
  5. 从 [版本分支] 检出 [特性分支]: git checkout -b feature-${xxx}
  6. 在 [特性分支] 修改代码（可以随时提交到 Github）
  7. 每完成一个需求修改后，在 Github 合并 [特性分支] 到 [版本分支]，此时会触发流水线自动 deploy SNAPSHOT 版本到 Maven 中央仓库
  8. 重复步骤 4 ~ 5， 直到当前版本的需求开发完成
  9. 宣布封版，在 Github 删除所有 [特性分支]
  10. 在本地切换到 [版本分支]: git checkout v${x.y.z}
  11. 拉取 [版本分支] 最新代码: git pull
  12. 批量修改父子所有 pom.xml 中的 <version>: 移除末尾的 -SNAPSHOT 快照标识
  13. 提交 [版本分支] 到 Github，此时会触发流水线自动生成 Javadoc
  14. 等待 Javadoc 发布完成（Github Actions 会推送变更到 [版本分支]）
  15. 在 Github 合并 [版本分支] 到 master
  16. 在 Github 对 [版本分支] 发起 Releases 动作（会强制新建 Tag，名称和 [版本分支] 一致），此时会触发流水线自动 deploy Release 版本到 Maven 中央仓库
  17. 重复步骤 1， 进入下一轮迭代

批量修改版本号，可以借助 bin/set_version.sh[ps1] 脚本

分支示意图 
graph LR
    master((master)) -- checkout --> version[vX.Y.Z<br/>版本分支]
    version -- checkout --> featureA(feature-AAA<br/>特性分支 A)
    version -- checkout --> featureN(feature-...<br/>特性分支 N)
    featureA -- merge:SNAPSHOT --> version
    featureN -- merge:SNAPSHOT --> version
    version -- merge:Javadoc --> master
    version -- archive:RELEASE --> tag((tag<br/>X.Y.Z))
Loading
发版流程示意图 
sequenceDiagram
    participant Local
    participant Github
    participant Github Action
    participant Sonatype
    participant Github Pages
    Github->>Local: 拉取 master 最新代码<br/>git pull
    Local->>Local: 检出 [版本分支]<br/>git checkout -b v${x.y.z}
    Local->>Local: 批量修改父子所有 pom.xml 的版本
    Note left of Local: 版本号 +1<br/>末尾增加 -SNAPSHOT
    Local->>Github: 提交 [版本分支]<br/>git push
    Local->>Local: 检出 [特性分支]<br/>git checkout -b feature-${xxx}
    loop 当前版本需求开发
        Local->>Local: 修改代码
        Local->>Github: 提交修改<br/>git push
        Github->>Github: 合并 [特性分支] 到 [版本分支]
        Github->>Github Action: 触发流水线
        Github Action->>Sonatype: 发布 SNAPSHOT 版本
    end
    Note left of Github: 封版
    Github->>Github: 删除所有 [特性分支]
    Local->>Local: 切换到 [版本分支]<br/>git checkout v${x.y.z}
    Local->>Local: 拉取 [版本分支] 最新代码<br/>git pull
    Local->>Local: 批量修改父子所有 pom.xml 的版本
    Note left of Local: 移除末尾的 -SNAPSHOT
    Local->>Github: 提交 [版本分支]<br/>git push
    loop 等待 Javadoc 发布
        Github->>Github Action: 触发流水线
        Github Action->>Github Pages: 发布 Javadoc
    end
    Github->>Github: 合并 [版本分支] 到 master
    Github->>Github: 对 [版本分支] 发起 Releases
    Note left of Github: 强制新建 Tag<br/>名称和 [版本分支] 一致
    Github->>Github Action: 触发流水线
    Github Action->>Sonatype: 发布 Release 版本
Loading

发布位置

在 pom.xml 中 <distributionManagement> 指定版本的发布目标位置是 sonatype nexus。

检索关键字 exp-blog 可检索到本工程的所有依赖构件：

用在 sonatype jira 注册的账号即可登录 sonatype nexus。