Repository: logging-log4net Updated Branches: refs/heads/develop 96a72df75 -> 8fb64656d
ReleaseInstructions: visited all links and improved introduction section Project: http://git-wip-us.apache.org/repos/asf/logging-log4net/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4net/commit/8fb64656 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4net/tree/8fb64656 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4net/diff/8fb64656 Branch: refs/heads/develop Commit: 8fb64656d53cea6ad66bb18e9b3a6c14bc6c7ba2 Parents: 96a72df Author: Dominik Psenner <dpsen...@apache.org> Authored: Thu Jul 20 16:39:01 2017 +0200 Committer: Dominik Psenner <dpsen...@apache.org> Committed: Thu Jul 20 16:39:01 2017 +0200 ---------------------------------------------------------------------- ReleaseInstructions.md | 113 ++++++++++++++++---------------------------- 1 file changed, 40 insertions(+), 73 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4net/blob/8fb64656/ReleaseInstructions.md ---------------------------------------------------------------------- diff --git a/ReleaseInstructions.md b/ReleaseInstructions.md index f5cbef8..7641843 100644 --- a/ReleaseInstructions.md +++ b/ReleaseInstructions.md @@ -1,51 +1,26 @@ # Introduction -THIS DOCUMENT NEEDS TO BE ADAPTED NOW WE'VE MOVED TO GIT +This document is a work in progress and was created in parallel to the release of Apache log4net 1.2.11 and adapted for 2.0.6. -This document is a work in progress and was created in parallel to the -release of Apache log4net 1.2.11 and adapted for 2.0.6. +## Important remark + +Note that we invest a great deal of effort into automating the release process by building a continuous delivery pipeline that runs on Jenkins. Further we have moved our codebase from SVN over to GIT and therefore large parts of this howto are no longer up do date! # Requirements -* make sure you have all the required software around. For the 2.0.6 - release this meant - * you may need a couple of Windows or Linux boxes in order to be - able to build all target frameworks. +* make sure you have all the required software around. For the 2.0.6 release this meant + * you may need a couple of Windows or Linux boxes in order to be able to build all target frameworks. * Things you need - * a Subversion command line client - * NAnt 0.92 or better http://nant.sourceforge.net/ - - Make sure to unblock the ZIP before you extract it. - * Some recent version of a Java runtime environment (Java5 at - minimum) - * Apache Maven 3.x http://maven.apache.org/ - - You may want to set some environment variables like Path (to - include Maven's and NAnt's bin directories), M2_HOME and - JAVA_HOME to make things easier. - * .NET Framework 3.5SP1 and SDK 2.0 - - As of October 2011 this is available from - <http://msdn.microsoft.com/en-us/netframework/> - * .NET Framework and SDK 4.0 - - As of October 2011 this is available from - <http://msdn.microsoft.com/en-us/netframework/> + * A Subversion command line client + * [NAnt 0.92 or better](http://nant.sourceforge.net/). Make sure to unblock the ZIP before you extract it. + * Some recent version of a Java runtime environment (Java5 at minimum) + * Apache Maven 3.x http://maven.apache.org/. You may want to set some environment variables like Path (to include Maven's and NAnt's bin directories), M2_HOME and JAVA_HOME to make things easier. + * .NET Framework 3.5SP1 and SDK 2.0; As of October 2011 this is available from [here](http://msdn.microsoft.com/en-us/netframework/) + * .NET Framework and SDK 4.0; As of October 2011 this is available from [here](http://msdn.microsoft.com/en-us/netframework/) * .NET Core Developer Kit available from https://www.microsoft.com/net/core - * Mono available from http://www.mono-project.com/download/ - - Unfortunately NAnt 0.92 has issues with Mono that is too recent, - I used a Ubuntu 14.04 installation and installed NAnt and Mono - via the Ubuntu Debian packages. It comes with Mono 3.2.8. - * Sandcastle Help File Builder with its Dependencies - - As of November 2015 this is available from - <https://github.com/EWSoftware/SHFB> - - Install Html Help 1 Compiler by follwoing the instructions - during the SGFB installation. It may tell you there'd already be - a newer version but SHFB needs this installation anyway. -* Make sure your PGP key is in `https://svn.apache.org/repos/asf/logging/log4net/trunk/KEYS` and copy that file to `https://dist.apache.org/repos/dist/release/logging/log4net/`. You should also upload your key to the keyservers. + * Mono available from [here](http://www.mono-project.com/download/). Unfortunately NAnt 0.92 has issues with Mono that is too recent, I used a Ubuntu 14.04 installation and installed NAnt and Mono via the Ubuntu Debian packages. It comes with Mono 3.2.8. + * Sandcastle Help File Builder with its Dependencies. As of November 2015 this is available from [here](https://github.com/EWSoftware/SHFB). Install Html Help 1 Compiler by follwoing the instructions during the SGFB installation. It may tell you there'd already be a newer version but SHFB needs this installation anyway. +* Make sure your PGP key is in <https://svn.apache.org/repos/asf/logging/log4net/trunk/KEYS> and copy that file to <https://dist.apache.org/repos/dist/release/logging/log4net/>. You should also upload your key to the keyservers. * Make sure you have decrypted `old-log4net.snk.gpg` to `old-log4net.snk` # Preparing the Stage @@ -53,22 +28,17 @@ release of Apache log4net 1.2.11 and adapted for 2.0.6. * Make sure the correct version number (2.0.6 right now) is in all the required places. [yes, there is a lot of duplication] - * log4net.build: <property name="package.version" value="2.0.6"/> - * pom.xml: <version>2.0.6</version> - * log4net.nuspec: <version>2.0.6</version> - * log4net.shfbproj: <HtmlHelpName>log4net-sdk-2.0.6</HtmlHelpName> - * src/AssemblyInfo.cs: many, many AssemblyInformationalVersionAttribute - * src/AssemblyVersionInfo.cpp as well as .cs, .vb and .js - twice in - each file - These files also hold the assembly's copyright statement. Make - sure it includes the current year. - * src/Log4netAssemblyInfo.cs: public const string Version = "2.0.6" - * src/site/xdocs/download_log4net.xml - many times - * netstandard/log4net/project.json - "version": "2.0.6", - * netstandard/log4net.tests/project.json - "version": "2.0.6", -* Create the site using "nant generate-site" in order to create the - RAT report as a side-effect and fix all files that don't have the - proper license header. + * `log4net.build`: `<property name="package.version" value="2.0.6"/>` + * `pom.xml`: `<version>2.0.6</version>` + * `log4net.nuspec`: `<version>2.0.6</version>` + * `log4net.shfbproj`: `<HtmlHelpName>log4net-sdk-2.0.6</HtmlHelpName>` + * `src/AssemblyInfo.cs`: many, many AssemblyInformationalVersionAttribute + * `src/AssemblyVersionInfo.cpp` as well as `.cs`, `.vb` and `.js` - twice in each file. These files also hold the assembly's copyright statement. Make sure it includes the current year. + * `src/Log4netAssemblyInfo.cs`: `public const string Version = "2.0.6"` + * `src/site/xdocs/download_log4net.xml`: many times + * `netstandard/log4net/project.json`: "version": "2.0.6", + * `netstandard/log4net.tests/project.json`: "version": "2.0.6", +* Create the site using "nant generate-site" in order to create the RAT report as a side-effect and fix all files that don't have the proper license header. * Make sure NOTICE corresponds to the general format of, in particular, check that {latest} is the current year. ``` Apache log4net @@ -78,7 +48,7 @@ This product includes software developed by The Apache Software Foundation (http://www.apache.org/). ``` * Update the release notes - * go to the Roadmap View in JIRA `https://issues.apache.org/jira/browse/LOG4NET#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmap-panel` + * go to the Roadmap View in JIRA <https://issues.apache.org/jira/browse/LOG4NET#selectedTab=com.atlassian.jira.plugin.system.project%3Aroadmap-panel> * follow the Release Notes link for the release you are going to create * Copy the text to `src/site/xdocs/release/release-notes.xml` in a new section for the new release and massage it to your liking. @@ -93,8 +63,8 @@ The Apache Software Foundation (http://www.apache.org/). * Create a fresh working copy of the new tag on the Linux box and copy `old-log4net.snk` to the root directory. * Run `nant` * zip up the bin/mono directory and copy it to the Windows machine -* Create a fresh working copy of the new tag on the Windows box and copy old-log4net.snk as well as nuget.exe to the root directory. -* Extract the contents of the Mono zip to bin/mono +* Create a fresh working copy of the new tag on the Windows box and copy `old-log4net.snk` as well as `nuget.exe` to the root directory. +* Extract the contents of the Mono zip to `bin/mono` * Run `nant` * Run SHFB * Run `nant package` @@ -106,13 +76,11 @@ The Apache Software Foundation (http://www.apache.org/). sha256sum $i > $i.sha256 \ gpg --detach-sign --armor $i; done ``` -* Commit the distribution files to dest area of the svn dist repository, i.e to `https://dist.apache.org/repos/dist/dev/logging/log4net` -* Also create a README.html based on the release-notes. +* Commit the distribution files to dest area of the svn dist repository, i.e to <https://dist.apache.org/repos/dist/dev/logging/log4net> +* Also create a `README.html` based on the release-notes. * Publish the site build somewhere convenient for you; `home.apache.org` is a good option * If you've got set up a myget feed, publish the nuget package -* call for a vote on the log4net-dev list. It may be a good idea to copy the general list of Logging Services in order to reach more PMC members. - The following is based on the template used in Commons - +* call for a vote on the log4net-dev list. It may be a good idea to copy the general list of Logging Services in order to reach more PMC members. The following is based on the template used in Commons ``` log4net 2.0.6 RC1 is available for review here: https://dist.apache.org/repos/dist/dev/logging/log4net (revision 17495) @@ -149,10 +117,9 @@ Thanks! # Publish the Release -* svn mv the ZIPs, hashes and signatures to `https://dist.apache.org/repos/dist/release/logging/log4net/source` and `https://dist.apache.org/repos/dist/release/logging/log4net/binaries` respectively. You can do so using a local working copy of `https://dist.apache.org/repos/dist` which tends to be huge, so check out selectively or using svnmucc. -* create a file README.html holding just the latest news from `release-notes.html` and svn commit it to `https://dist.apache.org/repos/dist/release/logging/log4net` +* svn mv the ZIPs, hashes and signatures to <https://dist.apache.org/repos/dist/release/logging/log4net/source> and <https://dist.apache.org/repos/dist/release/logging/log4net/binaries> respectively. You can do so using a local working copy of <https://dist.apache.org/repos/dist> which tends to be huge, so check out selectively or using svnmucc. +* create a file `README.html` holding just the latest news from `release-notes.html` and svn commit it to <https://dist.apache.org/repos/dist/release/logging/log4net> * create a svn tag for the release from the release candidate tag that has been accepted - ``` $ svn cp -m "1.2.14 release has been accepted" \ https://svn.apache.org/repos/asf/logging/log4net/tags/1.2.14RC1 \ @@ -163,20 +130,20 @@ Thanks! # Announce the Release -* publish the website by copying it to `https://svn.apache.org/repos/infra/websites/production/logging/content/log4net` by convention create a directory named after the release, e.g. copy site to `https://svn.apache.org/repos/infra/websites/production/logging/content/log4net/log4net-1.2.14´ +* publish the website by copying it to <https://svn.apache.org/repos/infra/websites/production/logging/content/log4net> by convention create a directory named after the release, e.g. copy site to <https://svn.apache.org/repos/infra/websites/production/logging/content/log4net/log4net-1.2.14> * Ensure line-feeds are consistent and that the cgi script has the svn:executable property set. -* Change the .htaccess files and 2.x/2.0.x symlinks in ´https://svn.apache.org/repos/infra/websites/production/logging/content/log4net´ so they point at your new directory. -* Copy ´download_log4net.html´ file from the new directory to `https://svn.apache.org/repos/infra/websites/production/logging/content/log4net´ +* Change the `.htaccess` files and 2.x/2.0.x symlinks in <https://svn.apache.org/repos/infra/websites/production/logging/content/log4net> so they point at your new directory. +* Copy ´download_log4net.html´ file from the new directory to <https://svn.apache.org/repos/infra/websites/production/logging/content/log4net> * Send an announcement mail at least to using your u...@apache.org email address. PGP sign the announcement email. * log4net-...@logging.apache.org * log4net-u...@logging.apache.org * gene...@logging.apache.org * annou...@apache.org * Mark the version as released in JIRA and create a new version for the next release if necessary -* Add the new version to the DOAP file at `https://svn.apache.org/repos/asf/logging/log4net/doap_log4net.rdf` -* Add the new version to the reporter tool `https://reporter.apache.org/addrelease.html?logging` +* Add the new version to the DOAP file at <https://svn.apache.org/repos/asf/logging/log4net/doap_log4net.rdf> +* Add the new version to the reporter tool <https://reporter.apache.org/addrelease.html?logging> # Post-Release Cleanup -* Delete all artifacts of old releases from `https://dist.apache.org/repos/dist/release/logging/log4net` +* Delete all artifacts of old releases from <https://dist.apache.org/repos/dist/release/logging/log4net>
