规范开源项目 - Maven/TravisCI/Coveralls

在GitHub上开了不少坑 ，但为了方便都是直接编写代码 。参考了不少优秀的作者，除了良好的代码风格之外，项目的描述/构建/Issue管理都有很好的规范。今年首要目标就是完善之前的坑，从项目构建开始~

Maven

还是延续之前的parent-pom/child-jar的结构

• parent中只留配置 : dependencies/plugins 都替换成 management节点

parent作为一个公共配置 ，包括使用到的dependencies和plugins

• 补充scm/issue等节点信息 ,供其他工具集成

项目的补充信息

• 增加source/javadoc等plugin ,方便第三方使用者使用.

开源项目必备，当然你得在写代码时就写好doc

• 增加代码扫描工具(最好是通过IDEA的编写时工具检测更好)

Sonarlint，阿里编码规约，前端的有jslint，编写时检测可以尽早提示你修改代码，也更容易记忆。

新的POM

  4.0.0

  site.koalazoo.cutekoala
  cute-koala
  0.1.0
  pom

  Cute Koala
  https://github.com/Anddd7/cute-koala
  Manage your Java Application easiler.

  
    
      Apache License, Version 2.0
      http://www.apache.org/licenses/LICENSE-2.0.txt
      repo
    
  

  
    GitHub Issues
    https://github.com/Anddd7/cute-koala/issues
  

  2017

  
    scm:git:https://github.com/Anddd7/cute-koala.git
    scm:git:[email protected]:Anddd7/cute-koala.git
    https://github.com/Anddd7/cute-koala
  

  
    
      and777
      Eddy Liao
      [email protected]
      
        owner
        developer
      
      +8
    
  

  
    koala-core
    koala-test
  

  
    UTF-8
    1.8

    4.12
    1.7.5
    1.16.18
    1.2.33
    6.0.6
    22.0
    2.7.16
    1.18
  

  
    
      
        org.slf4j
        slf4j-log4j12
        ${slf4j-log4j12.v}
      

      
        junit
        junit
        ${junit.v}
        test
      

      
        org.projectlombok
        lombok
        ${lombok.v}
        provided
      
    
  

  

    
      
        org.apache.maven.plugins
        maven-compiler-plugin
        3.6.1
        
          ${project.build.jdk.v}
          ${project.build.jdk.v}
        
      
    

    
      
        
          org.apache.maven.plugins
          maven-source-plugin
          2.1.2
          
            
              attach-sources
              
                jar-no-fork
              
            
          
        

        
          org.apache.maven.plugins
          maven-javadoc-plugin
          2.10.4
          
            true
            true
            -Xdoclint:-html
            ${project.build.sourceEncoding}
            ${project.build.sourceEncoding}
            ${project.build.sourceEncoding}
            -XDignore.symbol.file
            -Xdoclint:-html
            true
          
          
            
              attach-javadocs
              
                jar
              
            
          
        

        
          org.projectlombok
          lombok-maven-plugin
          1.16.18.1
          
            
              generate-sources
              
                delombok
              
            
          
        

        
          org.jacoco
          jacoco-maven-plugin
          0.7.6.201602180812
          
            
              prepare-agent
              
                prepare-agent
              
            
          
        

        
          org.eluder.coveralls
          coveralls-maven-plugin
          4.3.0
        

      
    
  

持续集成

之前尝试在阿里云上搭Jenkins ,因为内存爆炸(1G) ,以失败告终.在添加SCM节点时 ,搜索了一下集成的工具 ,发现了 Travis CI.

Travis是一个持续集成的平台 ,自带与GitHub的集成 ,能够检测代码提交并触发继承脚本.

• 进入官网使用GitHub登录 ,然后选择想要继承的repo
• 在repo下新建.travis.yml文件 ,写入自动集成触发的脚本
• push代码到github ,然后就可以到travis首页查看编译情况

coveralls是一个测试报告展示平台 ,能够集成多种测试报告 .也是在使用travis的时候检索到的 ,通过travis持续集成并生成测试报告 ,然后上传到coveralls .

• 使用GitHub账号登录 ,选择repo
• 复制repoToken

repoToken是你访问测试报告的凭证 ,因此不能明文上传到github上 ,但是我们又需要在CI中使用这个repoToken.

• 加密Token
  • 使用travis的对称加密工具(需要ruby gem工具):travis encrypt COVERALLS_TOKEN=xxxxxx
  • 复制加密后的token到.travis.yml文件中
  • 使用变量名访问
• 在travis脚本中使用token和测试报告生成工具
• 生成并上传测试报告

Java项目官方推荐了一个plugin使用 ,token不能使用明文 ,所以不能直接把token配置在pom中.而是在travis集成时 ,把解密后的token拿来使用.

在子项目中使用插件

    
      
      
        org.jacoco
        jacoco-maven-plugin
      
      
        org.eluder.coveralls
        coveralls-maven-plugin
      
    
  

.travis.yml的配置

language: java
sudo: false
script: mvn clean verify
after_success:
  - mvn clean test
  ## 生成测试报告
  - mvn jacoco:report
  ## 获取travis解密的token ,并调用coveralls-plugin上传报告
  - mvn coveralls:report -DrepoToken="${COVERALLS_TOKEN}"

## 加密后的token字串
env:
  global:
    - secure: "..............................."

这里是借助了travis的对称加密：把 coveralls上获取的仓库token加密后放到travis配置文件中。当travis平台运行时，会把配置文件中的密文都解密出来，其他配置（比如脚本）中就可以访问到当时加密的变量。
然后我再把token变量通过maven脚本传递到plugin中，就可以实现上传report而不暴露明文的token了。

最后

就可以在主页上看到持续集成和测试报告的结果 ,还可以导入非常有逼格的budge（主要目的）

TravisCI

Coveralls