如何在Jenkinsfile脚本化流水线中使用Javadoc并通过Maven发布

前置准备 #

• 确保Jenkins已安装Javadoc插件和Maven Integration插件，前者用于在Jenkins中展示Javadoc报告，后者支持Maven命令执行。

脚本化流水线示例 #

以下是完整的Jenkinsfile脚本，覆盖拉取代码、生成Javadoc、发布到Jenkins的全流程：

node {
    stage('拉取代码') {
        git url: '你的代码仓库地址', branch: 'main'
    }

    stage('构建并生成Javadoc') {
        // 执行Maven命令，生成Javadoc到默认目录target/site/apidocs
        sh 'mvn clean install javadoc:javadoc'
        // 若仅需生成Javadoc无需完整构建，可改用：sh 'mvn javadoc:javadoc'
    }

    stage('发布Javadoc到Jenkins') {
        // 调用Jenkins Javadoc插件发布报告
        publishJavadoc(
            javadocDir: 'target/site/apidocs', // 指定Javadoc生成目录
            title: '项目Javadoc文档', // 自定义Jenkins中显示的文档标题
            keepAll: true, // 保留所有历史构建的Javadoc
            allowMissing: false, // 若Javadoc目录不存在则标记构建失败
            failOnError: true // 生成Javadoc出错时标记构建失败
        )
    }
}

关键说明 #

• mvn javadoc:javadoc：Maven的Javadoc插件会根据项目中的注释生成HTML格式文档，默认输出到target/site/apidocs目录。如果需要自定义生成规则（比如指定源码范围、排除类、添加参数等），可在项目pom.xml中配置maven-javadoc-plugin的相关参数。
• publishJavadoc步骤：这是Jenkins Javadoc插件提供的流水线专属步骤，完成后可在Jenkins构建详情页点击「Javadoc」入口直接查看生成的文档。

内容的提问来源于stack exchange，提问作者DavidBoe