src/documentation/content/xdocs/versioning.xml - poi - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!--
    ====================================================================
    Licensed to the Apache Software Foundation (ASF) under one or more
    contributor license agreements.  See the NOTICE file distributed with
    this work for additional information regarding copyright ownership.
    The ASF licenses this file to You under the Apache License, Version 2.0
    (the "License"); you may not use this file except in compliance with
    the License.  You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
    ====================================================================
 -->
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

 <document>
   <header>
     <title>Apache POI™ - Versioning</title>
     <authors>
       <person id="PJF" name="PJ Fanning" email="fanningpj@apache.org"/>
     </authors>
   </header>

   <body>
     <section><title>Versioning</title>
       <p>
         Apache POI™ releases are available under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
         from the <a href="site:download">Download</a> page.
       </p>
       <p>
         The versioning scheme for Apache POI is based on the principles of
         <a href="https://semver.org/">Semantic Versioning 2.0.0</a>.
       </p>
       <p>
         We started using this versioning scheme in Apache POI 4.0.0. Versions prior
         to this did not follow exactly the same principles with the numbers typically being of the form
         X.Y. X indicated the major version but there may in some cases, have been big changes between
         minor versions.
       </p>
     </section>
     <section><title>Version Support</title>
       <p>
         Work on 6.0.0 has started in the trunk branch. Java 8 support is being removed.
         Some deprecated APIs are being removed. The exact scope of changes will be
         determined as development progresses.
       </p>
       <p>
         5.5.x releases will continue to be made for critical bug fixes and security issues.
         When 6.0.0 is released, 5.5.x will be supported for a limited time after that.
         The exact duration of support will be determined at that time.
       </p>
       <p>
         There is no longer any support for POI releases 4.x and earlier. Users
         are strongly encouraged to upgrade to the latest version of POI.
       </p>
     </section>
     <section><title>Migrating from older versions</title>
       <p>
         Typically, migrating from one major version to the next should be straightforward.
         Before migrating, you should check if you are using any deprecated APIs and try to update
         your code by following the deprecation notices.
       </p>
       <p>
         If you are migrating across multiple major versions, it is recommended to do this
         step by step, i.e. first migrate to the next major version, test your application
         and then continue to the next major version. A method might have been deprecated
         in one major version and then removed in the next major version.
       </p>
       <p>
         Minor versions may introduce new features and deprecate existing APIs.
         They might also contain bug fixes that could potentially affect existing functionality.
       </p>
       <p>
         POI 5.0.0 renamed the ooxml-schemas jar to poi-ooxml-full and
         poi-ooxml-schemas jar to poi-ooxml-lite. Please check your dependencies
         when migrating from POI 4.x to POI 5.x.
       </p>
       <p>
         Please check the <a href="changes.html">Change Log</a> for details about
         what has changed in each version.
       </p>
       <p>
         You can also check the <a href="apidocs/index.html">Javadocs</a> online for
         various releases.
       </p>
       <p>
         The <a href="https://poi.apache.org/help/faq.html">FAQ</a> may also contain
         useful information.
       </p>
       <p>
         If you encounter any issues when migrating, please report them to the
         <a href="https://poi.apache.org/help/index.html">mailing list</a>.
       </p>
     </section>
   </body>
   <footer>
     <legal>
       Copyright (c) @year@ The Apache Software Foundation All rights reserved.
       <br />
       Apache POI, POI, Apache, the Apache logo, and the Apache
       POI project logo are trademarks of The Apache Software Foundation.
     </legal>
   </footer>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!--
	====================================================================
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	====================================================================
	-->
	<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

	<document>
	<header>
	<title>Apache POI™ - Versioning</title>
	<authors>
	<person id="PJF" name="PJ Fanning" email="fanningpj@apache.org"/>
	</authors>
	</header>

	<body>
	<section><title>Versioning</title>
	<p>
	Apache POI™ releases are available under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
	from the <a href="site:download">Download</a> page.
	</p>
	<p>
	The versioning scheme for Apache POI is based on the principles of
	<a href="https://semver.org/">Semantic Versioning 2.0.0</a>.
	</p>
	<p>
	We started using this versioning scheme in Apache POI 4.0.0. Versions prior
	to this did not follow exactly the same principles with the numbers typically being of the form
	X.Y. X indicated the major version but there may in some cases, have been big changes between
	minor versions.
	</p>
	</section>
	<section><title>Version Support</title>
	<p>
	Work on 6.0.0 has started in the trunk branch. Java 8 support is being removed.
	Some deprecated APIs are being removed. The exact scope of changes will be
	determined as development progresses.
	</p>
	<p>
	5.5.x releases will continue to be made for critical bug fixes and security issues.
	When 6.0.0 is released, 5.5.x will be supported for a limited time after that.
	The exact duration of support will be determined at that time.
	</p>
	<p>
	There is no longer any support for POI releases 4.x and earlier. Users
	are strongly encouraged to upgrade to the latest version of POI.
	</p>
	</section>
	<section><title>Migrating from older versions</title>
	<p>
	Typically, migrating from one major version to the next should be straightforward.
	Before migrating, you should check if you are using any deprecated APIs and try to update
	your code by following the deprecation notices.
	</p>
	<p>
	If you are migrating across multiple major versions, it is recommended to do this
	step by step, i.e. first migrate to the next major version, test your application
	and then continue to the next major version. A method might have been deprecated
	in one major version and then removed in the next major version.
	</p>
	<p>
	Minor versions may introduce new features and deprecate existing APIs.
	They might also contain bug fixes that could potentially affect existing functionality.
	</p>
	<p>
	POI 5.0.0 renamed the ooxml-schemas jar to poi-ooxml-full and
	poi-ooxml-schemas jar to poi-ooxml-lite. Please check your dependencies
	when migrating from POI 4.x to POI 5.x.
	</p>
	<p>
	Please check the <a href="changes.html">Change Log</a> for details about
	what has changed in each version.
	</p>
	<p>
	You can also check the <a href="apidocs/index.html">Javadocs</a> online for
	various releases.
	</p>
	<p>
	The <a href="https://poi.apache.org/help/faq.html">FAQ</a> may also contain
	useful information.
	</p>
	<p>
	If you encounter any issues when migrating, please report them to the
	<a href="https://poi.apache.org/help/index.html">mailing list</a>.
	</p>
	</section>
	</body>
	<footer>
	<legal>
	Copyright (c) @year@ The Apache Software Foundation All rights reserved.
	<br />
	Apache POI, POI, Apache, the Apache logo, and the Apache
	POI project logo are trademarks of The Apache Software Foundation.
	</legal>
	</footer>
	</document>