Jenkins集成

  1. Jenkins服务器需要安装maven, maven的安装步骤这里不再阐述。
  2. 点击Manage Jenkins-> Configure System -> Maven installations, 设置好maven的安装目录
  3. 添加一个项目
  4. Source Code Management: 根据自身情况进行配置
  5. Build:选择maven
  6. Maven Version选择刚才第2步中设置的Maven

  7. Maven Goals:输入框根据项目需要传递相应参数(详细的参数用法请参考https://wrdoclet.winroad.net/autoGeneration/command.html)，比如：

    Windows环境

    clean
javadoc:javadoc
-Dwrdoclet.branchname=release
-Dwrdoclet.systemname=demoDubbo
-Ddubboconfigpath="C:/Program Files (x86)/Jenkins/workspace/demoDubbo/src/main/resources/spring/applicationContext-dubbo.xml"
-Dwrdoclet.buildid=%BUILD_ID%

    Linux环境

    clean
javadoc:javadoc
-Dwrdoclet.branchname=release
-Dwrdoclet.systemname=demoDubbo
-Ddubboconfigpath="${WORKSPACE}/src/main/resources/spring/applicationContext-dubbo.xml"
-Dwrdoclet.buildid=${BUILD_ID}
-Dwrdoclet.output="${WORKSPACE}/target/apidocs-demodubbo"

    这里需要注意Windows环境的dubboconfigpath的路径配置，曾经尝试使用环境变量%WORKSPACE%来代替绝对路径，但貌似Windows环境无效。

  8. Add build step:根据环境选择"Execute Windows batch command" or "Execute shell"。执行文档自动发布到solr搜索引擎的命令。比如：

    Windows环境

    python c:\Tools\wrdoclet\wrdoclet-solr\solrPublish.py -i "%WORKSPACE%\demoDubbo\target\site\apidocs" -s http://192.168.1.2:8080/solr/apidocs -b %BUILD_ID%

    Linux 环境

    python /usr/local/src/wrdoclet/wrdoclet-solr/solrPublish.py -i "${WORKSPACE}/demoDubbo/target/site/apidocs" -s http://192.168.1.2:8080/solr/apidocs -b ${BUILD_ID}

说明

上文中-Dwrdoclet.branchname、-Dwrdoclet.systemname以及-Dwrdoclet.buildid、-Dwrdoclet.output这几个参数是在POM文件自定义的参数。具体可参见 https://github.com/WinRoad-NET/wrdoclet-demo/ 中几个项目的POM.xml。 branchname为分支名称； systemname为系统名称； buildid用于识别两次不同的接口文档构建，默认使用系统时间赋值，建议使用jenkins自带的${BUILD_ID}赋值； output用于定义文档的输出路径。

如果需要使用docker image来运行jenkins，可参考 https://github.com/WinRoad-NET/wrdoclet-jenkins-docker 项目编写 Dockerfile文件。

results matching ""

    No results matching ""