index.html

<!DOCTYPE html>
<html class="no-js" lang="zh-CN">
  <head>
    <meta charset="utf-8">
    
    <link rel="preload" href="https://jenkins-zh.cn/files/muli-latin-200.woff2" as="font" type="font/woff2" crossorigin>
    <link rel="preload" href="https://jenkins-zh.cn/files/muli-latin-400.woff2" as="font" type="font/woff2" crossorigin>
    <link rel="preload" href="https://jenkins-zh.cn/files/muli-latin-800.woff2" as="font" type="font/woff2" crossorigin>

    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
     
     <title>Jenkins 插件开发之旅：两天内从 idea 到发布(上篇) - Jenkins 中文社区</title>
     <meta name="HandheldFriendly" content="True">
    <meta name="MobileOptimized" content="320">
    
    <meta name="description" content="两天内，从产生 idea 到编写插件，最后发布到 Jenkins 插件更新中心">
    
    
    <meta name="keywords" content="Jenkins,Jenkins中文社区,Jenkins官方公众号,持续集成,持续交付,开源社区,DevOps">
    

    <meta name="viewport" content="width=device-width,minimum-scale=1">
     <meta name="generator" content="Hugo 0.54.0" />

      
        <META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
      

    <link href='/dist/main.css' rel='stylesheet' type="text/css" /><style>
  img.avatar {
    width: 32px;
    display: inline;
  }
</style>
<meta property="og:title" content="Jenkins 插件开发之旅：两天内从 idea 到发布(上篇)" />
<meta property="og:description" content="两天内，从产生 idea 到编写插件，最后发布到 Jenkins 插件更新中心" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://jenkins-zh.cn/wechat/articles/2019/05/2019-05-06-jenkins-plugin-develop-within-two-days-part01/" />
<meta property="article:published_time" content="2019-05-06T00:00:00&#43;00:00"/>
<meta property="article:modified_time" content="2019-05-06T00:00:00&#43;00:00"/>

<meta itemprop="name" content="Jenkins 插件开发之旅：两天内从 idea 到发布(上篇)">
<meta itemprop="description" content="两天内，从产生 idea 到编写插件，最后发布到 Jenkins 插件更新中心">


<meta itemprop="datePublished" content="2019-05-06T00:00:00&#43;00:00" />
<meta itemprop="dateModified" content="2019-05-06T00:00:00&#43;00:00" />
<meta itemprop="wordCount" content="547">


<meta itemprop="keywords" content="jenkins,maven,jira," />
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Jenkins 插件开发之旅：两天内从 idea 到发布(上篇)"/>
<meta name="twitter:description" content="两天内，从产生 idea 到编写插件，最后发布到 Jenkins 插件更新中心"/>

        
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-4216293-5"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'UA-4216293-5');


var trackOutboundLink = function(id, url) {
  console.log("track:", id, url)
  gtag('event', 'click', {
    'event_category': 'outbound',
    'event_label': id,
    'transport_type': 'beacon',
    'event_callback': function(){document.location = url;}
  });
}

</script>

      
  </head>
  <body class="ma0 sans-serif bg-primary-color-light">
    
<nav class="bg-primary-color-dark pv4 w-100" role="navigation">

  <div class="center flex-ns flex-wrap items-center justify-start mw9">

    <h1 class="dim f3 lh-solid ml0-ns mr0 mr4-l mv0 pl3 pl4-ns">
      <a href="https://jenkins-zh.cn/" class="link white">
         Jenkins 中文社区
      </a>
    </h1>
    <ul class="list ma0 pa0 dn dib-l">
      
        <li class="f5 dib mr4" role="menuitem">
            
            
          <a href="/wechat/" class="dim link light-silver"
            >
            博客
              
            
          </a>
        </li>
      
        <li class="f5 dib mr4" role="menuitem">
            
            
          <a href="/event/" class="dim link light-silver"
            >
            活动
              
            
          </a>
        </li>
      
        <li class="f5 dib mr4" role="menuitem">
            
            
          <a href="/about/" class="dim link light-silver"
            >
            关于我们
              
            
          </a>
        </li>
      
        <li class="f5 dib mr4" role="menuitem">
            
            
          <a href="http://jenkins.io/zh" class="dim link light-silver"
            target="_blank">
            Jenkins 官网
              
            
              <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="10" height="10" viewBox="0 0 32 32" class="fill-current v-base" aria-label="External Link">
<path d="M25.152 16.576v5.696q0 2.144-1.504 3.648t-3.648 1.504h-14.848q-2.144 0-3.648-1.504t-1.504-3.648v-14.848q0-2.112 1.504-3.616t3.648-1.536h12.576q0.224 0 0.384 0.16t0.16 0.416v1.152q0 0.256-0.16 0.416t-0.384 0.16h-12.576q-1.184 0-2.016 0.832t-0.864 2.016v14.848q0 1.184 0.864 2.016t2.016 0.864h14.848q1.184 0 2.016-0.864t0.832-2.016v-5.696q0-0.256 0.16-0.416t0.416-0.16h1.152q0.256 0 0.416 0.16t0.16 0.416zM32 1.152v9.12q0 0.48-0.352 0.8t-0.8 0.352-0.8-0.352l-3.136-3.136-11.648 11.648q-0.16 0.192-0.416 0.192t-0.384-0.192l-2.048-2.048q-0.192-0.16-0.192-0.384t0.192-0.416l11.648-11.648-3.136-3.136q-0.352-0.352-0.352-0.8t0.352-0.8 0.8-0.352h9.12q0.48 0 0.8 0.352t0.352 0.8z"></path>
</svg>

            
          </a>
        </li>
      
    </ul>

    <div class="db dib-ns pl3"><form id="site-search-form" action="" role="search">
  <fieldset class="bn ma0 pa0">
    <label class="clip" for="email-address">Search</label>
    <input type="search" id="search-input" class="needs-js bg-left bg-transparent bn f5 input-reset lh-solid mt3 mt0-ns pl4 pv2 w5 white"
      placeholder="搜索文档" type="text"
      name="email-address" value="" style="background-image:url('/images/icon-search.png');background-size:16px 16px;">
  </fieldset>
</form>
</div>

    <div class="list ma0 pa0 dn dib-l"></div>

    <span class="absolute mt1 mt2-l pr3 right-0 top-0">

<a class="github-button needs-js link primary-color-dark" href="https://github.com/jenkins-zh/jenkins-zh/" data-size="large" data-show-count="false" aria-label="Star Jenkins WeChat GitHub">Star</a>
</span>

  </div>
</nav>

    
    <main role="main" class="content-with-sidebar min-vh-100 pb7 pb0-ns">
      
<main>
  <article class="w-100 ph4 pb5 pb6-ns pt1 pt5-ns">
    <div class="flex-l">
      

      <div class="order-2 w-100 w-20-l ph5-m ph0-l mb4 sticky">


  <aside class="mw5 br3 mv3 nested-links">
    
    
        <h3 class="f4 dib">
            Wang Donghui
        </h3>

      
        <p class="lh-copy measure center mt0 f6 black-60">
          a long-time Jenkins user and contributor
        </p>
      
      <a href="https://github.com/donhui" target="_blank" class="link dim v-mid dib">
        <svg version="1.1" fill="gray" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="16" height="18" viewBox="0 0 27 32">
<path d="M9.28 21.44q0.064-0.128-0.064-0.256-0.16-0.128-0.256-0.032-0.064 0.128 0.064 0.224 0.16 0.128 0.256 0.064zM8.768 20.704q-0.096-0.128-0.224-0.096-0.096 0.096 0 0.224 0.128 0.16 0.224 0.096t0-0.224zM8.032 19.968q0.032-0.064-0.096-0.128-0.128-0.032-0.128 0.032-0.064 0.096 0.064 0.16 0.16 0.032 0.16-0.064zM8.416 20.384q0.032 0 0.032-0.064t-0.064-0.096q-0.128-0.128-0.192-0.064t0.032 0.192q0.096 0.096 0.192 0.032zM9.952 21.728q0.032-0.128-0.16-0.192-0.16-0.064-0.224 0.064t0.16 0.192q0.16 0.064 0.224-0.064zM10.688 21.792q0-0.16-0.192-0.16t-0.192 0.16 0.192 0.128 0.192-0.128zM11.392 21.664q-0.032-0.128-0.224-0.096t-0.16 0.16q0.032 0.16 0.192 0.096t0.192-0.16zM22.848 16q0-3.776-2.656-6.464t-6.464-2.688-6.464 2.688-2.688 6.464q0 2.976 1.76 5.376t4.48 3.296q0.32 0.064 0.48-0.096t0.16-0.352q0-0.928-0.032-1.696-0.096 0.032-0.256 0.064t-0.64 0.032-0.864-0.096-0.768-0.352-0.544-0.736q-0.416-1.056-1.024-1.312-0.032-0.032-0.064-0.064l-0.16-0.16t-0.096-0.16 0.064-0.128 0.352-0.064q0.096 0 0.256 0.032t0.544 0.288 0.576 0.64q0.288 0.48 0.672 0.736t0.768 0.256 0.704-0.064 0.512-0.16q0.128-0.864 0.608-1.248-0.896-0.096-1.536-0.32t-1.312-0.704-0.992-1.344-0.352-2.144q0-1.408 0.96-2.464-0.448-1.088 0.096-2.4 0.32-0.128 0.96 0.128t1.088 0.512l0.448 0.288q1.056-0.288 2.304-0.288t2.272 0.288q0.192-0.128 0.512-0.32t0.992-0.448 1.024-0.16q0.512 1.312 0.096 2.4 0.928 1.056 0.928 2.464 0 1.024-0.256 1.792t-0.64 1.248-0.928 0.8-1.12 0.448-1.216 0.224q0.608 0.544 0.608 1.696 0 0.704 0 1.6t-0.032 0.896q0 0.224 0.16 0.352t0.48 0.096q2.752-0.928 4.512-3.296t1.728-5.376zM27.424 7.424v17.152q0 2.112-1.504 3.616t-3.648 1.536h-17.12q-2.144 0-3.648-1.536t-1.504-3.616v-17.152q0-2.112 1.504-3.616t3.648-1.536h17.12q2.144 0 3.648 1.536t1.504 3.616z"></path>
</svg>

      </a>
  </aside>


<aside class="fixed-lTK mw5-l right-0 f6 bl-l b--moon-gray pv4 pv0-ns ph4-l nested-list-reset nested-links nested-copy-line-height">
	
		<p class="b">此页面上的内容</p>
  	<nav id="TableOfContents">
<ul>
<li>
<ul>
<li><a href="#从一个-idea-说起">从一个 idea 说起</a></li>
<li><a href="#插件开发过程">插件开发过程</a>
<ul>
<li><a href="#插件开发准备">插件开发准备</a></li>
<li><a href="#创建一个插件">创建一个插件</a></li>
<li><a href="#构建及运行插件">构建及运行插件</a></li>
<li><a href="#定制开发插件">定制开发插件</a>
<ul>
<li><a href="#扩展点-extensitonpoint">扩展点（ ExtensitonPoint ）</a></li>
<li><a href="#descriptor-静态内部类">Descriptor 静态内部类</a></li>
<li><a href="#数据绑定">数据绑定</a></li>
<li><a href="#核心逻辑">核心逻辑</a></li>
</ul></li>
<li><a href="#分发插件">分发插件</a></li>
</ul></li>
<li><a href="#插件使用说明">插件使用说明</a></li>
<li><a href="#总结">总结</a></li>
<li><a href="#参考">参考</a></li>
</ul></li>
</ul>
</nav>
	

	<div date-pref>
		<a href=".." class="dib f6 pl1 hover-bg-light-gray br-100">
			<svg class="fill-current" height="30px" viewBox="0 0 24 24" width="30px" xmlns="http://www.w3.org/2000/svg">
      <path transform="rotate(90 11.704999923706055,12.000000000000002) " d="m15.41,7.41l-1.41,-1.41l-6,6l6,6l1.41,-1.41l-4.58,-4.59l4.58,-4.59z" id="svg_1"/>
    <path d="M0 0h24v24H0z" fill="none"/>
</svg>

		</a>
		
		
			<a href="https://jenkins-zh.cn/wechat/articles/2019/05/2019-05-07-jenkins-install-plugins-shell/" class="dib f6 pl1 hover-bg-light-gray br-100" title="Jenkins 自动化安装插件 ">
				<svg class="fill-current" height="30px" viewBox="0 0 24 24" width="30px" xmlns="http://www.w3.org/2000/svg">
    <path d="M15.41 7.41L14 6l-6 6 6 6 1.41-1.41L10.83 12z"/>
    <path d="M0 0h24v24H0z" fill="none"/>
</svg>

			</a>
		

			<a href="https://jenkins-zh.cn/wechat/articles/2019/04/2019-04-30-what-cicd-tool-should-i-use/" class="dib f6 pr1 hover-bg-light-gray br-100" title="应该使用什么 CI/CD 工具？">
			<svg class="fill-current" height="30px" viewBox="0 0 24 24" width="30px" xmlns="http://www.w3.org/2000/svg">
    <path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"/>
    <path d="M0 0h24v24H0z" fill="none"/>
</svg>

			</a>
		
	</div>

</aside>
</div>

      <div class="order-1 w-80-l mw8 ph0 ph5-ns mid-gray nested-copy-line-height no-underline nested-links nested-img nested-copy-seperator nested-blockquote mt0-ns" style="flex-grow:1;">
        <div class="documentation-copy center mw8">
          <div id="readout" class="fixed right-0 bottom-0">
          </div>
          <header class="flex-none w-100">
  
  <h1 class="lh-title mb3 mv0 pt3 primary-color-dark">Jenkins 插件开发之旅：两天内从 idea 到发布(上篇)</h1>
</header>

<aside class="bt bw1 pt3 mt2 mid-gray b--mid-gray fn w-100">
  
    <div class="f4 fw4 lh-copy">
      两天内，从产生 idea 到编写插件，最后发布到 Jenkins 插件更新中心
    </div>
  

</aside>


<div class="prose" id="prose">


<p><img src="huashan.png" alt="huashan" /></p>

<p>本文介绍了笔者首个 Jenkins 插件开发的旅程，
包括从产生 idea 开始，然后经过插件定制开发，
接着申请将代码托管到 jenkinsci GitHub  组织，
最后将插件发布到 Jenkins 插件更新中心的过程。</p>

<p>鉴于文章篇幅过长，将分为上下两篇进行介绍。</p>

<h2 id="从一个-idea-说起">从一个 idea 说起</h2>

<p>前几天和朋友聊天时，聊到了 Maven 版本管理领域的 SNAPSHOT 版本依赖问题，
这给他带来了一些困扰，消灭掉历史遗留应用的 SNAPSHOT 版本依赖并非易事。</p>

<p>类似问题也曾经给笔者带来过困扰，在最初没能去规避问题，
等到再想去解决问题时却发现困难重重，牵一发而动全身，
导致这个问题一直被搁置，而这也给笔者留下深刻的印象。</p>

<p>等到再次制定 Maven 规范时，从一开始就考虑
强制禁止 SNAPSHOT 版本依赖发到生产环境。</p>

<p>这里是通过在 Jenkins 构建时做校验实现的。
因为没有找到提供类似功能的 Jenkins 插件，
目前这个校验通过 shell 脚本来实现的，
具体的做法是在 Jenkins 任务中 Maven 构建之前增加一个 Execute shell 的步骤，
来判断 pom.xml 中是否包含 SNAPSHOT 关键字，如果包含，该次构建状态将被标记为失败。
脚本内容如下：</p>

<pre><code class="language-bash">#!/bin/bash
if [[ ` grep -R --include=&quot;pom.xml&quot; SNAPSHOT .` =~ &quot;SNAPSHOT&quot; ]]; 
then echo &quot;SNAPSHOT check failed&quot; &amp;&amp; grep -R --include=&quot;pom.xml&quot; SNAPSHOT . &amp;&amp; exit 1; 
else echo &quot;SNAPSHOT check success&quot;; 
fi
</code></pre>

<p>恰好前不久在看 Jenkins 插件开发文档，
那何不通过 Jenkins 插件的方式实现它呢？</p>

<p>于是笔者开始了首个 Jenkins 插件开发之旅。</p>

<h2 id="插件开发过程">插件开发过程</h2>

<p>Jenkins 是由 Java 语言开发的最流行的 CI/CD 引擎。</p>

<p>说起 Jenkins 强大的开源生态，自然就会说到 Jenkins 插件。
Jenkins 插件主要用来对 Jenkins 的功能进行扩展。
目前 Jenkins 社区有<a href="https://plugins.jenkins.io/">上千个插件</a>，
用户可以根据自己的需求选择合适的插件来定制 Jenkins 。</p>

<h3 id="插件开发准备">插件开发准备</h3>

<p>插件开发需要首先安装 JDK 和 Maven，这里不做进一步说明。</p>

<h3 id="创建一个插件">创建一个插件</h3>

<p>Jenkins 为插件开发提供了 Maven 原型。
打开一个命令行终端，切换到你想存放 Jenins 插件源代码的目录，运行如下命令：</p>

<pre><code>mvn -U archetype:generate -Dfilter=io.jenkins.archetypes:
</code></pre>

<p>这个命令允许你使用其中一个与 Jenkins 相关的原型生成项目。</p>

<pre><code>$ mvn -U archetype:generate -Dfilter=io.jenkins.archetypes:
......
Choose archetype:
1: remote -&gt; io.jenkins.archetypes:empty-plugin (Skeleton of a Jenkins plugin with a POM and an empty source tree.)
2: remote -&gt; io.jenkins.archetypes:global-configuration-plugin (Skeleton of a Jenkins plugin with a POM and an example piece of global configuration.)
3: remote -&gt; io.jenkins.archetypes:hello-world-plugin (Skeleton of a Jenkins plugin with a POM and an example build step.)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): : 3
Choose io.jenkins.archetypes:hello-world-plugin version:
1: 1.1
2: 1.2
3: 1.3
4: 1.4
Choose a number: 4: 4
......
[INFO] Using property: groupId = unused
Define value for property 'artifactId': maven-snapshot-check
Define value for property 'version' 1.0-SNAPSHOT: :
[INFO] Using property: package = io.jenkins.plugins.sample
Confirm properties configuration:
groupId: unused
artifactId: maven-snapshot-check
version: 1.0-SNAPSHOT
package: io.jenkins.plugins.sample
 Y: : Y
</code></pre>

<p>笔者选择了 <code>hello-world-plugin</code> 这个原型，
并在填写了一些参数，如artifactId、version 后生成了项目。<br />
可以使用 <code>mvn verify</code> 命令验证是否可以构建成功。</p>

<h3 id="构建及运行插件">构建及运行插件</h3>

<p><code>Maven HPI Plugin</code> 用于构建和打包 Jenkins 插件。
它提供了一种便利的方式来运行一个已经包含了当前插件的 Jenkins 实例：</p>

<pre><code>mvn hpi:run
</code></pre>

<p>这将安装一个 Jenkins 实例，可以通过 <code>http://localhost:8080/jenkins/</code> 来访问。
等待控制台输出如下内容，然后打开 Web 浏览器并查看插件的功能。</p>

<pre><code>INFO: Jenkins is fully up and running
</code></pre>

<p>在 Jenkins 中创建一个自由风格的任务，然后给它取个名字。
然后添加 &ldquo;Say hello world&rdquo; 构建步骤，如下图所示：<br />
<img src="say-hello-world.png" alt="say hello world" /></p>

<p>输入一个名字，如：Jenkins ，然后保存该任务，
点击构建，查看构建日志，输出如下所示：</p>

<pre><code>Started by user anonymous
Building in workspace /Users/mrjenkins/demo/work/workspace/testjob
Hello, Jenkins! 
Finished: SUCCESS
</code></pre>

<h3 id="定制开发插件">定制开发插件</h3>

<p>Jenkins 插件开发归功于有一系列扩展点。
开发人员可以对其进行扩展自定义实现一些功能。</p>

<p>这里有几个重要的概念需要做下说明：</p>

<h4 id="扩展点-extensitonpoint">扩展点（ ExtensitonPoint ）</h4>

<p>扩展点是 Jenkins 系统某个方面的接口或抽象类。
这些接口定义了需要实现的方法，而 Jenkins 插件需要实现这些方法。</p>

<p>笔者所写的插件需要实现 Builder 这个扩展点。
代码片段如下：</p>

<pre><code class="language-java">public class MavenCheck extends Builder {}
</code></pre>

<h4 id="descriptor-静态内部类">Descriptor 静态内部类</h4>

<p>Descriptor 静态内部类是一个类的描述者，用于指明这是一个扩展点的实现，
Jenkins 通过这个描述者才能知道我们写的插件。
每一个描述者静态类都需要被 @Extension 注解，
Jenkins 内部会扫描 @Extenstion 注解来获取注册了哪些插件。<br />
代码片段如下：</p>

<pre><code class="language-java">@Extension
public static final class DescriptorImpl extends BuildStepDescriptor&lt;Builder&gt; {
    public DescriptorImpl() {
        load();
    }

    @Override
    public boolean isApplicable(Class&lt;? extends AbstractProject&gt; aClass) {
        return true;
    }

    @Override
    public String getDisplayName() {
        return &quot;Maven SNAPSHOT Check&quot;;
    }
}
</code></pre>

<p>在 DesciptorImpl 实现类中有两个方法需要我们必须要进行重写：
isApplicable() 和 getDisplayName() 。
isApplicable() 这个方法的返回值代表这个 Builder 在 Jenkins Project 中是否可用，
我们可以将我们的逻辑写在其中，例如做一些参数校验，
最后返回 true 或 false 来决定这个 Builder 是否可用。</p>

<p>getDisplayName() 这个方法返回的是一个 String 类型的值，
这个名称被用来在 web 界面上显示。</p>

<h4 id="数据绑定">数据绑定</h4>

<p>前端页面的数据要和后台服务端进行交互，需要进行数据绑定。
前端 <code>config.jelly</code> 页面代码片段如下：</p>

<pre><code class="language-xml">&lt;?jelly escape-by-default='true'?&gt;
&lt;j:jelly xmlns:j=&quot;jelly:core&quot; xmlns:st=&quot;jelly:stapler&quot; xmlns:d=&quot;jelly:define&quot; xmlns:l=&quot;/lib/layout&quot; xmlns:t=&quot;/lib/hudson&quot; xmlns:f=&quot;/lib/form&quot;&gt;
  &lt;f:entry title=&quot;check&quot; field=&quot;check&quot;&gt;
    &lt;f:checkbox /&gt;
  &lt;/f:entry&gt;
&lt;/j:jelly&gt;
</code></pre>

<p>如上所示，需要在 config.jelly 中包含需要传入的参数配置信息的选择框，field 为 check ，这样可以在 Jenkins 进行配置，然后通过 DataBoundConstructor 数据绑定的方式，将参数传递到 Java 代码中。
服务端 Java 代码片段如下：</p>

<pre><code>@DataBoundConstructor
public MavenCheck(boolean check) {
    this.check = check;
}
</code></pre>

<h4 id="核心逻辑">核心逻辑</h4>

<p>笔者所写的插件的核心逻辑是检查 Maven pom.xml 文件是否包含 SNAPSHOT 版本依赖。</p>

<p>Jenkins 是 Master/Agent 架构，
这就需要读取 Agent 节点的 workspace 的文件，
这是笔者在写插件时遇到的一个难点。</p>

<p>Jenkins 强大之处在于它的生态，目前有上千个插件，
笔者参考了 <a href="https://plugins.jenkins.io/text-finder">Text-finder Plugin</a> 的源码，
并在参考处添加了相关注释，最终实现了插件要实现的功能。</p>

<p>详细代码可以查看 <a href="https://github.com/jenkinsci/maven-snapshot-check-plugin">jenkinsci/maven-snapshot-check-plugin</a> 代码仓库。</p>

<h3 id="分发插件">分发插件</h3>

<p>使用 <code>mvn package</code> 命令可以打包出后缀为 hpi 的二进制包，
这样就可以分发插件，将其安装到 Jenkins 实例。</p>

<h2 id="插件使用说明">插件使用说明</h2>

<p>以下是对插件的使用简要描述。</p>

<p>如果勾选了下面截图中的选择框，
Jenkins 任务在构建时将会检查 pom.xml 中是否包含 SNAPSHOT 。
<img src="maven-snapshot-check-plugin-usage.png" alt="maven-snapshot-check-plugin-usage" /></p>

<p>如果检查到的话，则会将该次构建状态标记为失败。
<img src="job-build-console-output.png" alt="job-build-console-output" /></p>

<h2 id="总结">总结</h2>

<p>文章上篇主要介绍了从产生 idea 到插件开发完成的过程。<br />
那么插件在开发完成后是如何将它托管到 Jenkins 插件更新中心让所有用户都可以看到的呢？<br />
两天后的文章下篇将对这个过程进行介绍，敬请期待！</p>

<h2 id="参考">参考</h2>

<ul>
<li><a href="https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial">Plugin tutorial</a></li>
<li><a href="https://jenkins.io/doc/developer/tutorial/prepare/">Preparing for Plugin Development</a></li>
<li><a href="https://jenkins.io/doc/developer/tutorial/create/">Create a Plugin</a></li>
<li><a href="https://jenkins.io/doc/developer/tutorial/run/">Build and Run the Plugin</a></li>
</ul>

</div>


<aside class="bt bw1 pt3 mt2 mid-gray b--mid-gray fn w-100">

</aside>


<script src="https://utteranc.es/client.js"
        repo="jenkins-zh/jenkins-zh.github.io"
        issue-term="pathname"
        theme="github-light"
        crossorigin="linuxsuren"
        async>
</script>


        </div>
      </div>
      

    </div>
  </article>

  <div class="w-100 bg-light-gray">
    <div class="mw7 pa4 center nested-lh-copy lh-copy">
      <h6 class="f4 dark-gray mb2">
  <a href="https://jenkins-zh.cn/wechat/articles/2019/05/2019-05-06-jenkins-plugin-develop-within-two-days-part01/" class="hide-child link primary-color">
  <span class="nl3 child"><svg class="grow" fill="" height="14px" viewBox="0 0 24 24" width="14px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/></svg>
</span>
    “Jenkins 插件开发之旅：两天内从 idea 到发布(上篇)”
  </a> 更新于：May 6, 2019
  <div>
    原文作者：<a href="" target="_blank">donhui</a>
  </div>
</h6>

      <a href="https://github.com/jenkins-zh/jenkins-zh/edit/master/content/wechat/articles/2019/05/2019-05-06-jenkins-plugin-develop-within-two-days-part01.md" class="
f6 ph3 pv1 br2 dib  tc ttu mv3 bg-primary-color white hover-bg-green link
" target="_blank">改善此页</a>

      
  <div class="nested-lh-copy">
    <ul class="list dib nested-links ml0 pl0">
      
        <li class="db mb2 b">
          Tags:
        </li>
        
          <li class="db dib-l mr3">
            <a class="tag" href="/tags/jenkins">
              jenkins
            </a>
          </li>
        
          <li class="db dib-l mr3">
            <a class="tag" href="/tags/maven">
              maven
            </a>
          </li>
        
          <li class="db dib-l mr3">
            <a class="tag" href="/tags/jira">
              jira
            </a>
          </li>
        
              
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-29-jenkins-release/" class="link">
              Jenkins 2.176~2.178版本更新
            </a>
          </li>
        
      
          <li class="db b mt4 mb2 mr2">
            Related entries:
          </li>
        
        
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-28-jenkins-pipeline-shared-lib-unit-test/" class="link">
              如何对 Jenkins 共享库进行单元测试
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-22-jacoco-coverage-for-functional-test/" class="link">
              基于 Jenkins &#43; JaCoCo 实现功能测试代码覆盖率统计
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-20-jenkins-ansible-springboot/" class="link">
              使用 Jenkins &#43; Ansible 实现 Spring Boot 自动化部署101
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-17-from-jenkins-to-jenkins-x/" class="link">
              从 Jenkins 到 Jenkins X
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-15-gsoc-annoncement/" class="link">
              19年 GSoC 中 Jenkins 的七个项目
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-14-devops-jenkins-credential-manage/" class="link">
              基于 Jenkins 的 DevOps 平台应该如何设计凭证管理
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-13-jenkins-book-gift/" class="link">
              Jenkins 公众号送书福利
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-09-jenkins-release/" class="link">
              Jenkins 版本发布
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-08-jenkins-plugin-develop-within-two-days-part02/" class="link">
              Jenkins 插件开发之旅：两天内从 idea 到发布(下篇)
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/05/2019-05-07-jenkins-install-plugins-shell/" class="link">
              Jenkins 自动化安装插件
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-29-progressive-delivery-with-jenkins-x-automatic-cana/" class="link">
              使用 Jenkins X 渐进式交付：自动化金丝雀部署
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-26-progressive-delivery-with-jenkins-x/" class="link">
              使用 Jenkins X 渐进式交付
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-25-jenkins-ansible-nginx/" class="link">
              使用 Jenkins &#43; Ansible 实现自动化部署 Nginx
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-23-jenkins-master-shared-home/" class="link">
              关于 Jenkins master 共享 JENKINS_HOME 目录的实验
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-19-the-business-value-of-cd/" class="link">
              持续交付的商业价值
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-15-zabbix-monitor-jenkins/" class="link">
              使用 Zabbix 监控 Jenkins
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-12-brief-analysis-the-encryption-algorithm-of-the-built-in-jenkins-user-database/" class="link">
              简析 Jenkins 专有用户数据库加密算法
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-10-getting-started-with-docker-for-java-applications/" class="link">
              Java 应用使用 Docker 的入门指南：建立一个 CI/CD 流水线
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/04/2019-04-08-becoming-contributor-intro/" class="link">
              介绍：成为一名 Jenkins 贡献者的旅程
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/03/2019-03-13-electron-pipeline-demo/" class="link">
              Electron 应用的流水线设计
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/03/2019-03-13-ready-for-cdf/" class="link">
              为 Continuous Delivery Foundation 的成立感到兴奋
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/03/2019-01-08-mpl-modular-pipeline-library/" class="link">
              MPL - 模块化的流水线库
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/02/2019-02-27-jenkins-script-console-in-practice/" class="link">
              批量修改 Jenkins 任务的技巧
            </a>
          </li>
        
      
          <li class="db dib-l mb2 mr3">
            <a href="/wechat/articles/2019/01/2019-01-16-webhook-firewalls/" class="link">
              在安全防火墙内通过 WebHook 触发构建
            </a>
          </li>
        
      
    </ul>
  </div>


    </div>
  </div>
</main>

    </main>

    <footer class="bg-primary-color-dark ph4-ns pt4 relative w-100" role="contentinfo">
  <div class="center flex-ns flex-wrap justify-between mw9 w-90">
    <div class="pb3 pt4 w-100 w-50-ns">

      <div class="b f3  light-gray mb3 nested-links tc">
        由 <a href="https://github.com/jenkins-zh/jenkins-zh/graphs/contributors" target="_blank" class="link">Jenkins 社区贡献者</a> 维护<br/>
      </div>

      <ul class="center f6 list ma0 mv3 pa0 tc" style="display:none"><li class="dib mr3"><a href="https://github.com/jenkins-zh/jenkins-zh/issues/new" class="dim link light-gray pv2">File an Issue</a></li></ul>

      <ul class="center f6 list ma0 mv4 pa0 tc">
        <li class="dib mr3">
          <a href="https://twitter.com/suren69811254" target="_blank" class="dim link light-gray pv2">@suren69811254</a>
        </li>
        <li class="dib mr3">
          <a href="https://www.youtube.com/channel/UC63xz3pq26BBgwB3cnwCoqQ" target="_blank" class="dim link light-gray pv2">YouTube</a>
        </li>
      </ul>

      
    </div>

    <div>
      <a href="https://mp.weixin.qq.com/s/vifdduC3kRGSIMpyL03yVA" target="_blank">
        <img src="https://jenkins.io/images/jenkins-wechat.png" with="100" height="100">
      </a>
    </div>

  </div>

  <div class="f7 gray mb5 mb0-ns ph3 w-100" style="display:none"> 
    <p class="dib mr4">Jenkins&reg; is a registered trademark of <a href="https://www.spi-inc.org/" class="link">Software in the Public Interest, Inc.</a></p>
    <p class="dib">Copyright 2018–2019 the original authors.</p>
  </div>


  <div class="bg-primary-color-dark bottom-0 left-0 right-0 dn-l fixed pb3 ph3 w-100"><div  class="globalmenu mobilemenu pb3 dn">
    

<ul class="list hidden dib ph0 ma0 scrolling-touch tc">
  
    <li  class="tl dib ma0 hover-bg-black w-100">
        <a href="/wechat/" class="ttu f6 link primary-color-light overflow hover-white db brand-font  ma0 w-100 pv3 ph4">
          博客
        </a>
    </li>
  
    <li  class="tl dib ma0 hover-bg-black w-100">
        <a href="/event/" class="ttu f6 link primary-color-light overflow hover-white db brand-font  ma0 w-100 pv3 ph4">
          活动
        </a>
    </li>
  
    <li  class="tl dib ma0 hover-bg-black w-100">
        <a href="/about/" class="ttu f6 link primary-color-light overflow hover-white db brand-font  ma0 w-100 pv3 ph4">
          关于我们
        </a>
    </li>
  
    <li  class="tl dib ma0 hover-bg-black w-100">
        <a href="http://jenkins.io/zh" class="ttu f6 link primary-color-light overflow hover-white db brand-font  ma0 w-100 pv3 ph4">
          Jenkins 官网
        </a>
    </li>
  
</ul>

</div>
<div  class="docsmenu mobilemenu pb3 dn">
    

<ul class="list dib ph0 ma0 scrolling-touch tc">
  
</ul>

</div>

<div class="flex dn-l justify-between">
  <button class="js-toggle flex-auto dib dn-l f6 tc db mt4-ns ph3 pv2 link mr2 white bg-primary-color-dark hover-bg-primary-color ba b--white-40 w-auto" data-target=".globalmenu">Menu</button>

  <button class="js-toggle flex-auto dib dn-l f6 tc db mt4-ns ph3 pv2 link white bg-primary-color-dark hover-bg-primary-color ba b--white-40 w-auto" data-target=".docsmenu">Docs Menu</button>
</div>
</div>

</footer>

    
<link href="/dist/auto-complete.css" rel="stylesheet">
<script type="text/javascript">
    
        var baseurl = "https:\/\/jenkins-zh.cn\/";
    
</script>
<script src="/dist/lunr.js"></script>
<script src="/dist/autocomplete.js"></script>
<script src="/dist/jquery-3.2.1.min.js"></script>
<script src="/dist/search.js"></script>

<script async defer src="https://buttons.github.io/buttons.js"></script>
<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?6db234f713318730f0e5f6a95bdd8d47";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
<script>
(function(){
var src = (document.location.protocol == "http:") ? "http://js.passport.qihucdn.com/11.0.1.js?6276dcef5c15f276644151772390c1f9":"https://jspassport.ssl.qhimg.com/11.0.1.js?6276dcef5c15f276644151772390c1f9";
document.write('<script src="' + src + '" id="sozz"><\/script>');
})();
</script>


  </body>
</html>