lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shazwa...@apache.org
Subject [lucenenet] branch master updated: versioning doc and release notes
Date Tue, 05 May 2020 02:46:08 GMT
This is an automated email from the ASF dual-hosted git repository.

shazwazza pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git


The following commit(s) were added to refs/heads/master by this push:
     new 7cec5f0  versioning doc and release notes
7cec5f0 is described below

commit 7cec5f07dba18f0a4d21eec423d733dc8cb6e7e5
Author: Shannon <sdeminick@gmail.com>
AuthorDate: Tue May 5 12:45:55 2020 +1000

    versioning doc and release notes
---
 websites/site/contributing/make-release.md        | 37 ++--------------------
 websites/site/contributing/versioning.md          | 38 +++++++++++++++++++++++
 websites/site/download/version-4.8.0-beta00008.md |  4 +++
 3 files changed, 45 insertions(+), 34 deletions(-)

diff --git a/websites/site/contributing/make-release.md b/websites/site/contributing/make-release.md
index f248733..a291d7f 100644
--- a/websites/site/contributing/make-release.md
+++ b/websites/site/contributing/make-release.md
@@ -7,40 +7,9 @@ Making a release of Lucene.Net
 > [!NOTE]
 > This is a project-specific procedure, based on the [Apache Release Creation Process](https://infra.apache.org/release-publishing.html)
 
-## Versioning Procedure Overview
+## Versioning
 
-### Package Version
-
-The version number that is used in the build process is called the *Package Version*, 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.
-
-- Since Lucene.NET is a port of a [semantically versioned](https://semver.org/) component,
our versioning scheme is to use the same version number as Lucene on production release (i.e.
`4.8.0`). Any patches thereafter (breaking API change or not) will add a revision number (i.e
`4.8.0.1`).
-
-- We are also using pre-release version numbers (i.e. `4.8.0-beta00001`) for all unstable
versions up to the production release. When doing pre-releases, revision numbers are not supported.
-
-- **ONLY when changes are updated from a newer Lucene version to Lucene.NET**, the Lucene.NET
version number is updated to match the Lucene version (i.e. `4.8.0` > `4.8.1` or `4.8.0`
> `5.10.0`).
-
-- Version numbers always progress in the following order
-	- Pre-Release (i.e. `4.8.0-beta00001`)
-	- Production Release (i.e. `4.8.0`)
-	- Production Release Patch N (i.e where N is 1, `4.8.0.1`, where N is 2, `4.8.0.2`, etc)
-
-- Version numbers correspond to GitHub milestones, so when releasing a milestone, the same
version number should be used
-
-### Git Tag Version
-
-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: 
-
-```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
-
-```
+For Package Version, Nuget version and branch naming guidelines see the [Versioning Procedure
Overview](xref:contributing/versioning) document. 
 
 ## Release Preparation
 
@@ -208,7 +177,7 @@ The release notes are listed at:
 https://github.com/apache/lucenenet/releases/tag/[tag-url]"
 
 The release was made using the Lucene.NET release process, documented on the website:
-https://lucenenet.apache.org/release.html <!-- TODO: Update URL -->
+https://lucenenet.apache.org/contributing/make-release.html
 
 Please vote on releasing these packages as Apache Lucene.NET [version]. The vote is open
for at least the next 72 hours, i.e. midnight UTC on [YYYY-MM-DD]
 http://www.timeanddate.com/counters/customcounter.html?year=[YYYY]&month=[MM]&day=[DD]
diff --git a/websites/site/contributing/versioning.md b/websites/site/contributing/versioning.md
new file mode 100644
index 0000000..2d24c53
--- /dev/null
+++ b/websites/site/contributing/versioning.md
@@ -0,0 +1,38 @@
+---
+uid: contributing/versioning
+---
+Versioning Procedure Overview
+===============
+
+## Package Version
+
+The version number that is used in the build process is called the *Package Version*, 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.
+
+- Since Lucene.NET is a port of a [semantically versioned](https://semver.org/) component,
our versioning scheme is to use the same version number as Lucene on production release (i.e.
`4.8.0`). Any patches thereafter (breaking API change or not) will add a revision number (i.e
`4.8.0.1`).
+
+- We are also using pre-release version numbers (i.e. `4.8.0-beta00001`) for all unstable
versions up to the production release. When doing pre-releases, revision numbers are not supported.
+
+- **ONLY when changes are updated from a newer Lucene version to Lucene.NET**, the Lucene.NET
version number is updated to match the Lucene version (i.e. `4.8.0` > `4.8.1` or `4.8.0`
> `5.10.0`).
+
+- Version numbers always progress in the following order
+	- Pre-Release (i.e. `4.8.0-beta00001`)
+	- Production Release (i.e. `4.8.0`)
+	- Production Release Patch N (i.e where N is 1, `4.8.0.1`, where N is 2, `4.8.0.2`, etc)
+
+- Version numbers correspond to GitHub milestones, so when releasing a milestone, the same
version number should be used
+
+## Git Tag Version
+
+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: 
+
+```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
+
+```
\ No newline at end of file
diff --git a/websites/site/download/version-4.8.0-beta00008.md b/websites/site/download/version-4.8.0-beta00008.md
index b208ea7..27a9aa0 100644
--- a/websites/site/download/version-4.8.0-beta00008.md
+++ b/websites/site/download/version-4.8.0-beta00008.md
@@ -17,6 +17,10 @@ _Released:_ `2020-05-05`
     PM> Install-Package Lucene.Net -Version 4.8.0-beta00008
 </div>
 
+## Release notes
+
+[https://github.com/apache/lucenenet/releases/tag/Lucene.Net_4_8_0_beta00008](https://github.com/apache/lucenenet/releases/tag/Lucene.Net_4_8_0_beta00008)
+
 ### Source code
 
 * [Git Repository](https://github.com/apache/lucenenet)


Mime
View raw message