| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Versioning Procedure Overview | Apache Lucene.NET 4.8.0 </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Versioning Procedure Overview | Apache Lucene.NET 4.8.0 "> |
| <meta name="generator" content="docfx 2.58.0.0"> |
| |
| <link rel="shortcut icon" href="../logo/favicon.ico"> |
| <link rel="stylesheet" href="../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../styles/docfx.css"> |
| <link rel="stylesheet" href="../styles/main.css"> |
| <meta property="docfx:navrel" content="../toc.html"> |
| <meta property="docfx:tocrel" content="toc.html"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:400,700%7CMerriweather%7CRoboto+Mono"> |
| <link rel="stylesheet" href="/styles/site.css"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <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="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="contributing/versioning"> |
| <h1 id="versioning-procedure-overview">Versioning Procedure Overview</h1> |
| |
| <h2 id="package-version">Package Version</h2> |
| <p>The version number that is used in the build process is called the <em>Package Version</em>, which is the same version number used for the NuGet package. The assembly version, file version, and informational version are all derived from the Package Version during the build process. The Package Version uses the following rules.</p> |
| <ul> |
| <li><p>Since Lucene.NET is a port of a <a href="https://semver.org/">semantically versioned</a> component, our versioning scheme is to use the same version number as Lucene on production release (i.e. <code>4.8.0</code>). Any patches thereafter (breaking API change or not) will add a revision number (i.e <code>4.8.0.1</code>).</p> |
| </li> |
| <li><p>We are also using pre-release version numbers (i.e. <code>4.8.0-beta00001</code>) for all unstable versions up to the production release. When doing pre-releases, revision numbers are not supported.</p> |
| </li> |
| <li><p><strong>ONLY when changes are updated from a newer Lucene version to Lucene.NET</strong>, the Lucene.NET version number is updated to match the Lucene version (i.e. <code>4.8.0</code> > <code>4.8.1</code> or <code>4.8.0</code> > <code>5.10.0</code>).</p> |
| </li> |
| <li><p>Version numbers always progress in the following order</p> |
| <ul> |
| <li>Pre-Release (i.e. <code>4.8.0-beta00001</code>)</li> |
| <li>Production Release (i.e. <code>4.8.0</code>)</li> |
| <li>Production Release Patch N (i.e where N is 1, <code>4.8.0.1</code>, where N is 2, <code>4.8.0.2</code>, etc)</li> |
| </ul> |
| </li> |
| <li><p>Version numbers correspond to GitHub milestones, so when releasing a milestone, the same version number should be used</p> |
| </li> |
| </ul> |
| <h2 id="git-tag-version">Git Tag Version</h2> |
| <p>For legacy reasons, tagging the Git repository to indicate a version uses a different version format, but it must include all of the elements of the Package Version, for example:</p> |
| <pre><code class="lang-txt"># Pre-Release |
| Lucene.Net_4_8_0_beta00001 |
| |
| # Production Release |
| Lucene.Net_4_8_0 |
| |
| # Production Release Patch (breaking API changes included) |
| Lucene.Net_4_8_0_1 |
| |
| </code></pre> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/master/websites/site/contributing/versioning.md/#L1" class="contribution-link">Improve this Doc</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <h5>In This Article</h5> |
| <div></div> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2022 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../styles/docfx.js"></script> |
| <script type="text/javascript" src="../styles/main.js"></script> |
| </body> |
| </html> |
