使用Maven和Docker进行持续交付中的版本号管理

阅读量：6348 次

发布时间：2019-06-22

本文共 5652 字，大约阅读时间需要 18 分钟。

动机

我们来思考下持续交付的原则。

每次构建的结果可能是一个潜在的发行版本

消除手动瓶颈

尽可能自动化

这三点正是我们想要实现的，但是在实现之前，我们先来看下在典型的Maven发布流程和经典方式版本号管理上的具体问题。

没有自动化

通常来说，一次提交会触发一个快照构建，然后生成一个快照构件（“8.1.2-SNAPSHOP”）。当开发者感觉软件到达稳定状态后，他会触发一次专用发布构建。因此，他预先分配版本号（“8.2.0”）

A human has to assign a version number and trigger the release build.

人员必须分配版本号然后触发发布构建

这种方式有什么缺点：

我们需要手动触发专用的发布工作流程

版本号需要人为手动分配

此外，仅看版本号“8.2.0”并不清晰，比如这个版本号的构件中包含了哪些提交(代码)。我们需要一个Git标签

任意快照

此外，快照引起了许多问题。

Unclear and changing content of snapshot artifacts.

不清晰的内容变动

不可追踪。我们不能说，有哪些提交包含在了当前的快照构件中。

不可靠。快照构件可以很快速的修改。这样很容易引起问题

易出错。不过不注意，很容易覆盖一个快照（比如：当创建Git分支的时候，忘记修改POM文件中的版本号。从Git分支上构建会覆盖之前的快照）

让人生气的Maven发布插件

最后，Maven的发布插件也引起了许多问题：

开销。Maven发布插件运行3次完整的构件和测试周期，展开POM文件两次和创建三次Git修订（Git revisions）

不具有隔离性。当其他人在发布版本期间提交更改时，插件可能容易陷入混乱。

不具有原子性。如果最后一步出现问题（比如：在构件上传期间），突然发现紧急Bug。我们必须清理创建的Git标签，Git修订和修复错误版本

解决方案：利用Git提交哈希

我们使用Git提交哈希来作为构件的版本号

Using the Git commit hash as the version number.

使用Git提交哈希作为版本号

每个构建都incident，有一个机器分配的唯一号码

因此，每个构件都是潜在可交付的。所以这里不需要一个专用的发布流程。

=> 交付管道大大简化和自动化

可追踪。这很明显，哪些提交被包含到构件中。

重复性。只需检出版本并再次进行构建构件（假设没有快照依赖）。

基本上，Git标签不再需要了。

实现

让我们在Maven构建中集成版本命名。下面的事例构建生成一个简单的Spring Boot服务作为Fat Jar。此外，我们把Fat Jar包装到Docker镜像中，并部署镜像。完整的源码可以在中查看。

为了增加人的可读性，我们把时间戳作为Git提交哈希的前缀。因此，我们的版本号如下所示：

format:  yyyyMMdd-HHmmss.abbreviatedCommitHashexample: 20160702-152019.75c54f5

使用Git提交哈希作为版本号

这是最重要的一步，我们使用。这个插件可以从.git目录读取Git提交哈希和提交时间戳，并可以在POM中可以使用Maven属性使用。


        
     
      pl.project13.maven
         
     
      git-commit-id-plugin
         
     
      2.2.1
         
             
                  
       
        validate
                   
                       
        
         revision
                    
               
          
         
             
      
       yyyyMMdd-HHmmss
      
              
      
       ${project.basedir}/.git
              
      
       false

下一步，我们可以在Maven属性中添加包含了Git提交哈希和提交时间戳的版本号属性。


       
     
      ${git.commit.time}.${git.commit.id.abbrev}

现在，我们可以在version标签中使用这个属性。


    
     de.philipphauer.blog
    
    
     versioning-continuous-delivery
    
    
     ${version.number}

使用方式：

> mvn package # creates the jar with the desired version number> java -jar target/versioning-continuous-delivery-20160702-180249.193a613.jar # starts the service

使用版本号创建、标记Docker镜像

我们使用 io.fabric8 的来创建镜像。重要的部分是标签。我们创建两个标签。一个标签以提交ID命名（“20160702-153902.7c12eb”），另一个以“latest”命名。latest标签将会简化本地测试。


        
     
      io.fabric8
         
     
      docker-maven-plugin
         
     
      0.15.9
         
     
      true
         
             
       
                   
       
        phauer
                   
       
        docker123
               
              
                  
                       
       
        ${docker.repository.name}:${version.number}
                       
       
        ${project.artifactId}
                       
                           
        
         anapsix/alpine-java:jre8
                            
        
                                 
         
          latest
                             
                            
                                
         
          assembly.xml
                             
                            
                                
         
          8080
                             
                            
                                
         
           java -jar /maven/${project.artifactId}-${version.number}.jar 
                             
                        
                           
          
         
             
                  
       
        build-docker-image
                   
       
        package
                   
                       
        
         build
                    
               
              
                  
       
        push-docker-image-to-registry
                   
       
        deploy
                   
                       
        
         push

不要忘记assembly.xml和如下的属性：


    
     phauer/${project.artifactId}

用法：

> mvn package # creates a docker image and installs it to the local repository> docker imagesREPOSITORY                                                TAG                              IMAGE ID            CREATED             SIZEphauer/versioning-continuous-delivery                     20160702-174649.28b5299          12d7a526c506        2 seconds ago       135.8 MBphauer/versioning-continuous-delivery                     latest                           12d7a526c506        2 seconds ago       135.8 MB> docker-compose up # starts the local image with the tag "latest"> mvn deploy # pushes the image to the docker registry

完整的和可以在GitHub中查看。