pmd_projectdocs_committers_releasing.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
<title>Releasing | PMD Source Code Analyzer</title>
<link rel="stylesheet" href="css/syntax.css">


<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="css/modern-business.css">
<link rel="stylesheet" href="css/lavish-bootstrap.css">
<link rel="stylesheet" href="css/customstyles.css">
<link rel="stylesheet" href="css/theme-blue.css">
<link rel="stylesheet" href="css/pmd-customstyles.css">

<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
<script src="js/jquery.navgoco.min.js"></script>


<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
<script src="js/toc.js"></script>
<script src="js/customscripts.js"></script>

<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
<link rel="icon" href="images/favicon.ico" type="image/x-icon">

<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->

<link rel="alternate" type="application/rss+xml" title="" href="https://pmd.github.io/pmd/feed.xml">

    <script>
        $(document).ready(function() {
            // Initialize navgoco with default options
            $("#mysidebar").navgoco({
                caretHtml: '',
                accordion: true,
                openClass: 'active', // open
                save: false, // leave false or nav highlighting doesn't work right
                cookie: {
                    name: 'navgoco',
                    expires: false,
                    path: '/'
                },
                slide: {
                    duration: 400,
                    easing: 'swing'
                }
            });

            $("#collapseAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', false);
            });

            $("#expandAll").click(function(e) {
                e.preventDefault();
                $("#mysidebar").navgoco('toggle', true);
            });

        });

    </script>
    <script>
        $(function () {
            $('[data-toggle="tooltip"]').tooltip()
        })
    </script>
    <script>
        $(document).ready(function() {
            $("#tg-sb-link").click(function() {
                $("#tg-sb-sidebar").toggle();
                $("#tg-sb-content").toggleClass('col-md-9');
                $("#tg-sb-content").toggleClass('col-md-12');
                $("#tg-sb-icon").toggleClass('fa-toggle-on');
                $("#tg-sb-icon").toggleClass('fa-toggle-off');
            });
        });
    </script>
    

</head>
<body>
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding-top rule in modern-business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
<div id="topbar-content-offset">
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container topnavlinks">
        <div class="navbar-header">
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
        </div>
        <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
            <ul class="nav navbar-nav navbar-right">
                <!-- toggle sidebar button -->
                <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
                <!-- entries without drop-downs appear here -->
                
                
                <li><a href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
                
                
                <li><a href="https://github.com/pmd/pmd" target="_blank">Fork us on github</a></li>
                
                
                <!-- entries with drop-downs appear here -->
                <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
                
                
                <!--comment out this block if you want to hide search-->
                <li>
                    <!--start search-->
                    <div id="search-demo-container">
                        <input type="text" id="search-input" placeholder="search...">
                        <ul id="results-container"></ul>
                    </div>
                    <script src="js/jekyll-search.js" type="text/javascript"></script>
                    <script type="text/javascript">
                            SimpleJekyllSearch.init({
                                searchInput: document.getElementById('search-input'),
                                resultsContainer: document.getElementById('results-container'),
                                dataSource: 'search.json',
                                searchResultTemplate: '<li><a href="{url}" title="Releasing">{title}</a></li>',
                    noResultsText: 'No results found.',
                            limit: 10,
                            fuzzy: true,
                    })
                    </script>
                    <!--end search-->
                </li>
            </ul>
        </div>
        </div>
        <!-- /.container -->
</nav>

<!-- Page Content -->
<div class="container">
    <div class="col-lg-12">&nbsp;</div>
    <!-- Content Row -->
    <div class="row">
        
        
        <!-- Sidebar Column -->
        <div class="col-md-3" id="tg-sb-sidebar">
            

<ul id="mysidebar" class="nav">
    <li class="sidebarTitle">PMD 6.22.0</li>
    
    
    <li>
        
        <a href="#">About</a>
        
        <ul>
            
            
                <li><a href="index.html">Home</a></li>
                

                <li><a href="pmd_release_notes.html">Release notes</a></li>
                

                <li><a href="pmd_next_major_development.html">PMD 7.0.0 development</a></li>
                

                <li><a href="pmd_about_help.html">Getting help</a></li>
                

        </ul>
     </li>
       
        
    <li>
        
        <a href="#">User Documentation</a>
        
        <ul>
            
            
                <li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
                

                <li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
                

                <li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
                

                <li><a href="pmd_userdocs_best_practices.html">Best practices</a></li>
                

                <li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
                

                <li><a href="pmd_userdocs_incremental_analysis.html">Incremental analysis</a></li>
                

                <li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
                

                <li class="subfolders">
                    <a href="#">Extending PMD</a>
                    <ul>
                        
                        
                        <li><a href="pmd_userdocs_extending_writing_pmd_rules.html">Writing a rule</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_writing_xpath_rules.html">Writing XPath rules</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_designer_reference.html">Rule designer reference</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_metrics_howto.html">Using and defining code metrics</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
                        
                        
                        <li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li><a href="pmd_userdocs_cpd.html">Copy-paste detection</a></li>
                

                <li class="subfolders">
                    <a href="#">Tools / Integrations</a>
                    <ul>
                        
                        
                        <li><a href="pmd_userdocs_tools_maven.html">Maven PMD plugin</a></li>
                        
                        
                        <li><a href="pmd_userdocs_tools_ant.html">Ant</a></li>
                        
                        
                        <li><a href="pmd_userdocs_tools_ci.html">CI integrations</a></li>
                        
                        
                        <li><a href="pmd_userdocs_tools.html">Other Tools / Integrations</a></li>
                        
                        
                    </ul>
                </li>
                
                
        </ul>
     </li>
       
        
    <li>
        
        <a href="#">Rule Reference</a>
        
        <ul>
            
            
                <li class="subfolders">
                    <a href="#">Apex Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_apex.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_design.html">Design</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_documentation.html">Documentation</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_errorprone.html">Error Prone</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_performance.html">Performance</a></li>
                        
                        
                        <li><a href="pmd_rules_apex_security.html">Security</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Ecmascript Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_ecmascript.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_ecmascript_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_ecmascript_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_ecmascript_errorprone.html">Error Prone</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Java Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_java.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_java_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_java_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_java_design.html">Design</a></li>
                        
                        
                        <li><a href="pmd_rules_java_documentation.html">Documentation</a></li>
                        
                        
                        <li><a href="pmd_rules_java_errorprone.html">Error Prone</a></li>
                        
                        
                        <li><a href="pmd_rules_java_multithreading.html">Multithreading</a></li>
                        
                        
                        <li><a href="pmd_rules_java_performance.html">Performance</a></li>
                        
                        
                        <li><a href="pmd_rules_java_security.html">Security</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Java Server Pages Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_jsp.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_jsp_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_jsp_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_jsp_design.html">Design</a></li>
                        
                        
                        <li><a href="pmd_rules_jsp_errorprone.html">Error Prone</a></li>
                        
                        
                        <li><a href="pmd_rules_jsp_security.html">Security</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Maven POM Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_pom.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_pom_errorprone.html">Error Prone</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Modelica Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_modelica.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_modelica_bestpractices.html">Best Practices</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">PLSQL Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_plsql.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_plsql_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_plsql_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_plsql_design.html">Design</a></li>
                        
                        
                        <li><a href="pmd_rules_plsql_errorprone.html">Error Prone</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Salesforce VisualForce Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_vf.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_vf_security.html">Security</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">VM Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_vm.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_vm_bestpractices.html">Best Practices</a></li>
                        
                        
                        <li><a href="pmd_rules_vm_design.html">Design</a></li>
                        
                        
                        <li><a href="pmd_rules_vm_errorprone.html">Error Prone</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">XML Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_xml.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_xml_errorprone.html">Error Prone</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">XSL Rules</a>
                    <ul>
                        
                        
                        <li><a href="pmd_rules_xsl.html">Index</a></li>
                        
                        
                        <li><a href="pmd_rules_xsl_codestyle.html">Code Style</a></li>
                        
                        
                        <li><a href="pmd_rules_xsl_performance.html">Performance</a></li>
                        
                        
                    </ul>
                </li>
                
                
        </ul>
     </li>
       
        
    <li>
        
        <a href="#">Language Specific Documentation</a>
        
        <ul>
            
            
                <li><a href="pmd_languages_jsp.html">JSP Support</a></li>
                

                <li><a href="pmd_java_metrics_index.html">Java code metrics</a></li>
                

                <li><a href="pmd_apex_metrics_index.html">Apex code metrics</a></li>
                

        </ul>
     </li>
       
        
    <li>
        
        <a href="#">Developer Documentation</a>
        
        <ul>
            
            
                <li><a href="pmd_devdocs_development.html">Developer resources</a></li>
                

                <li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
                

                <li><a href="https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
                

                <li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
                

                <li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
                

                <li><a href="pmd_devdocs_how_pmd_works.html">How PMD works</a></li>
                

                <li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
                

                <li><a href="pmd_devdocs_rule_deprecation_policy.html">Rule Deprecation Policy</a></li>
                

                <li class="subfolders">
                    <a href="#">Major contributions</a>
                    <ul>
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_language.html">Adding a new language</a></li>
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_metrics_framework.html">Adding metrics support to a language</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li class="subfolders">
                    <a href="#">Experimental features</a>
                    <ul>
                        
                        
                        <li><a href="pmd_devdocs_experimental_ast_dump.html">Creating (XML) dump of the AST</a></li>
                        
                        
                    </ul>
                </li>
                
                
        </ul>
     </li>
       
        
    <li>
        
        <a href="#">Project documentation</a>
        
        <ul>
            
            
                <li class="subfolders">
                    <a href="#">Trivia about PMD</a>
                    <ul>
                        
                        
                        <li><a href="pmd_projectdocs_trivia_news.html">PMD in the press</a></li>
                        
                        
                        <li><a href="pmd_projectdocs_trivia_products.html">Products & books related to PMD</a></li>
                        
                        
                        <li><a href="pmd_projectdocs_trivia_similarprojects.html">Similar projects</a></li>
                        
                        
                        <li><a href="pmd_projectdocs_trivia_meaning.html">What does 'PMD' mean?</a></li>
                        
                        
                    </ul>
                </li>
                
                
                <li><a href="pmd_projectdocs_faq.html">FAQ</a></li>
                

                <li><a href="license.html">License</a></li>
                

                <li><a href="pmd_projectdocs_credits.html">Credits</a></li>
                

                <li><a href="pmd_release_notes_old.html">Old release notes</a></li>
                

                <li class="subfolders">
                    <a href="#">Project management</a>
                    <ul>
                        
                        
                        <li class="active"><a href="pmd_projectdocs_committers_releasing.html">Release process</a></li>
                        
                        
                        <li><a href="pmd_projectdocs_committers_merging_pull_requests.html">Merging pull requests</a></li>
                        
                        
                    </ul>
                </li>
                
                
        </ul>
     </li>
       
        
        <!-- if you aren't using the accordion, uncomment this block:
           <p class="external">
               <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
           </p>
           -->
</ul>

<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>

        </div>
        
        
        <!-- Content Column -->
        <div class="col-md-9" id="tg-sb-content">
            <div class="post-header">
   <h1 class="post-title-main">Releasing</h1>
</div>


<div class="post-content">

   
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
  // Handler for .ready() called.

$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });

});
</script>

<div id="toc"></div>

    
    <a target="_blank" href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/projectdocs/committers/releasing.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>

    
  <p>This page describes the current status of the release process.</p>

<p>Since versions 5.4.5 / 5.5.4 there is an automated release process using <a href="https://travis-ci.org">travis-ci</a>
in place. However, there are still a few steps, that need manual examination.</p>

<p>Note: You can find a small shell script in the root of the repo: <code class="highlighter-rouge">do-release.sh</code>. This script guides you
through the release process.</p>

<h2 id="preparations">Preparations</h2>

<p>Make sure code is up to date and everything is committed and pushed with git:</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ ./mvnw clean
$ git pull
$ git status
</code></pre></div></div>

<h3 id="the-release-notes-and-docs">The Release Notes and docs</h3>

<p>You can find the release notes here: <code class="highlighter-rouge">docs/pages/release_notes.md</code>.</p>

<p>The date and the version must be updated in <code class="highlighter-rouge">docs/_config.yml</code>,  e.g.</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pmd:
    version: 6.0.0
    date: 2017-12-15
    release_type: major
</code></pre></div></div>

<p>The release type could be one of “bugfix”, “minor”, or “major”.</p>

<p>The release notes usual mention any new rules that have been added since the last release.
Please double check the file <code class="highlighter-rouge">pmd-core/src/main/resources/rulesets/releases/&lt;version&gt;.xml</code>, so
that all new rules are listed.</p>

<p>Add the new rules as comments to the quickstart rulesets:</p>
<ul>
  <li><code class="highlighter-rouge">pmd-apex/src/main/resources/rulesets/apex/quickstart.xml</code></li>
  <li><code class="highlighter-rouge">pmd-java/src/main/resources/rulesets/java/quickstart.xml</code></li>
</ul>

<p>We maintain a documentation for the <a href="pmd_next_major_development.html">next major release</a>. Copy the API
changes from the current release notes to this document: <code class="highlighter-rouge">docs/pages/next_major_development.md</code>.</p>

<p>The designer lives at <a href="https://github.com/pmd/pmd-designer">pmd/pmd-designer</a>.
Update property <code class="highlighter-rouge">pmd-designer.version</code> in <strong>pom.xml</strong> to reference the latest pmd-designer release.
See <a href="https://search.maven.org/search?q=g:net.sourceforge.pmd%20AND%20a:pmd-ui&amp;core=gav">https://search.maven.org/search?q=g:net.sourceforge.pmd%20AND%20a:pmd-ui&amp;core=gav</a> for the available releases.</p>

<p>Check in all (version) changes to branch master or any other branch, from which the release takes place:</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ git commit -a -m "Prepare pmd release &lt;version&gt;"
$ git push
</code></pre></div></div>

<h3 id="the-homepage">The Homepage</h3>

<p>The github repo <code class="highlighter-rouge">pmd.github.io</code> hosts the homepage for <a href="https://pmd.github.io">https://pmd.github.io</a>.</p>

<p>The new version needs to be entered into <code class="highlighter-rouge">_config.yml</code>, e.g.:</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>pmd:
  latestVersion: 6.0.0
  latestVersionDate: 15th December 2017
</code></pre></div></div>

<p>Also move the previous version down into the “downloads” section.</p>

<p>Then create a new page for the new release, e.g. <code class="highlighter-rouge">_posts/2017-12-15-PMD-6.0.0.md</code> and copy
the release notes into this page. This will appear under the news section.</p>

<p>Check in all (version) changes to branch master:</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ git commit -a -m "Prepare pmd release &lt;version&gt;"
$ git push
</code></pre></div></div>

<h2 id="creating-the-release">Creating the release</h2>

<p>The release is created using the <strong>maven-release-plugin</strong>. This plugin changes the version by basically
removing the “-SNAPSHOT” suffix, builds the changed project locally, commits the version change, creates
a new tag from this commit, changes the version of the project to the next snapshot, commits this change
and pushes everything.</p>

<p><code class="highlighter-rouge">RELEASE_VERSION</code> is the version of the release. It is reused for the tag. <code class="highlighter-rouge">DEVELOPMENT_VERSION</code> is the
next snapshot version after the release.</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>mvn -B release:clean release:prepare \
    -Dtag=pmd_releases/${RELEASE_VERSION} \
    -DreleaseVersion=${RELEASE_VERSION} \
    -DdevelopmentVersion=${DEVELOPMENT_VERSION}
</code></pre></div></div>

<p>Once the maven plugin has pushed the tag, travis-ci will start and build a new version from this tag. Since
it is a tag build and a released version build, travis-ci will do a couple of additional stuff:</p>

<ul>
  <li>Deploy and release the build to maven central, so that it can be downloaded from
<a href="https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd/">https://repo.maven.apache.org/maven2/net/sourceforge/pmd/pmd/</a>. This is done automatically, if
all unit tests pass on travis-ci. The plugin <a href="https://github.com/sonatype/nexus-maven-plugins/tree/master/staging/maven-plugin">nexus-staging-maven-plugin</a> is used for that.</li>
  <li>Upload the new binaries to github releases under <a href="https://github.com/pmd/pmd/releases">https://github.com/pmd/pmd/releases</a>. It also uploads
the release notes.</li>
  <li>Upload the new binaries additionally to sourceforge, so that they can be downloaded from
<a href="https://sourceforge.net/projects/pmd/files/pmd/">https://sourceforge.net/projects/pmd/files/pmd/</a>, including the release notes. The new binaries are
selected as the new default downloads for PMD.</li>
  <li>Add the documentation of the new release to a subfolder on <a href="https://pmd.github.io">https://pmd.github.io</a>, also make
this folder available as <code class="highlighter-rouge">latest</code>.</li>
</ul>

<h2 id="after-the-release">After the release</h2>

<p>The release on travis currently takes about 30 minutes. Once this is done, you can spread the news:</p>

<h3 id="submit-a-news-on-sf">Submit a news on SF</h3>

<p>Submit news to SF on the <a href="https://sourceforge.net/p/pmd/news/">PMD Project News</a> page. You can use
the following template:</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>PMD &lt;version&gt; released

*   Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F&lt;version&gt;
*   Documentation: https://pmd.github.io/pmd-&lt;version&gt;/

And Copy-Paste the release notes
</code></pre></div></div>

<h3 id="write-an-email-to-the-mailing-list">Write an email to the mailing list</h3>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>To: PMD Developers List &lt;pmd-devel@lists.sourceforge.net&gt;
Subject: [ANNOUNCE] PMD &lt;version&gt; released


*   Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F&lt;version&gt;
*   Documentation: https://pmd.github.io/pmd-&lt;version&gt;/

And Copy-Paste the release notes
</code></pre></div></div>

<h2 id="prepare-the-next-release">Prepare the next release</h2>

<h3 id="prepare-the-new-release-notes">Prepare the new release notes</h3>

<ul>
  <li>Update version in <strong>docs/_config.yml</strong></li>
  <li>Move version/release info from <strong>docs/pages/release_notes.md</strong> to <strong>docs/pages/release_notes_old.md</strong>.</li>
  <li>Update version/release info in <strong>docs/pages/release_notes.md</strong>. Use the following template:</li>
</ul>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---

## {{ site.pmd.date }} - {{ site.pmd.version }}

The PMD team is pleased to announce PMD {{ site.pmd.version }}.

This is a {{ site.pmd.release_type }} release.

{% tocmaker %}

### New and noteworthy

### Fixed Issues

### API Changes

### External Contributions

{% endtocmaker %}

</code></pre></div></div>

<p>Commit and push</p>

<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ git commit -m "Prepare next development version"
$ git push origin master
</code></pre></div></div>

<h3 id="close--create-new-milestones">Close / Create new milestones</h3>

<p>Manage the milestones under <a href="https://github.com/pmd/pmd/milestones">https://github.com/pmd/pmd/milestones</a>.
Maybe there are some milestones on sourceforge, too: <a href="https://sourceforge.net/p/pmd/bugs/milestones">https://sourceforge.net/p/pmd/bugs/milestones</a>.</p>

<h2 id="branches">Branches</h2>

<h3 id="merging">Merging</h3>

<p>If the release was done on a maintenance branch, such as <code class="highlighter-rouge">pmd/5.4.x</code>, then this branch should be
merged into the next “higher” branches, such as <code class="highlighter-rouge">pmd/5.5.x</code> and <code class="highlighter-rouge">master</code>.</p>

<p>This ensures, that all fixes done on the maintenance branch, finally end up in the other branches.
In theory, the fixes should already be there, but you never now.</p>

<h3 id="multiple-releases">Multiple releases</h3>

<p>If releases from multiple branches are being done, the order matters. You should start from the “oldest” branch,
e.g. <code class="highlighter-rouge">pmd/5.4.x</code>, release from there. Then merge (see above) into the next branch, e.g. <code class="highlighter-rouge">pmd/5.5.x</code> and release
from there. Then merge into the <code class="highlighter-rouge">master</code> branch and release from there. This way, the last release done, becomes
automatically the latest release on <a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a> and on sourceforge.</p>

<h3 id="optional-create-a-new-release-branch">(Optional) Create a new release branch</h3>

<p>At some point, it might be time for a new maintenance branch. Such a branch is usually created from
the <code class="highlighter-rouge">master</code> branch. Here are the steps:</p>

<ul>
  <li>Create a new branch: <code class="highlighter-rouge">git branch pmd/5.6.x master</code></li>
  <li>Update the version in both the new branch and master, e.g. <code class="highlighter-rouge">mvn versions:set -DnewVersion=5.6.1-SNAPSHOT</code>
and <code class="highlighter-rouge">mvn versions:set -DnewVersion=5.7.0-SNAPSHOT</code>.</li>
  <li>Update the release notes on both the new branch and master</li>
</ul>


    <div class="tags">
        
    </div>


</div>

<hr class="shaded"/>

<footer>
            <div class="row">
                <div class="col-lg-12 footer">
               &copy;2020 PMD Open Source Project. All rights reserved. <br />
 Site last generated: Feb 12, 2020 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
                </div>
            </div>
</footer>


        </div>
        <!-- /.row -->
    </div>
    <!-- /.container -->
</div>
</div>
</body>

</html>