lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Trivial Update of "ReleaseTodo" by AnshumGupta
Date Thu, 11 Jun 2015 16:40:57 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The "ReleaseTodo" page has been changed by AnshumGupta:
https://wiki.apache.org/lucene-java/ReleaseTodo?action=diff&rev1=188&rev2=189

Comment:
Updated the release documentation.

  = Release Workflow =
   1. Go to the JIRA "Manage Versions" Administration pages (https://issues.apache.org/jira/plugins/servlet/project-config/LUCENE/versions
and https://issues.apache.org/jira/plugins/servlet/project-config/SOLR/versions) and add a
new (unreleased) version for the next release on the trunk (for a major release) or branch
(for a minor release).
   1. Check out the branch with: {{{svn co https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr_X_Y}}}
-  1. Build the code and javadocs, and run the unit tests: ant clean javadocs test. Make sure
that you are actually using the minimum compiler version supported for the release. For example,
5.x releases are on Java7 so make sure that you use Java7 for the release workflow.
+  1. Build the code and javadocs, and run the unit tests: ant clean test, ant javadocs (in
lucene/). Make sure that you are actually using the minimum compiler version supported for
the release. For example, 5.x releases are on Java7 so make sure that you use Java7 for the
release workflow.
-  1. Examine the results. Did it build without errors? Were there Javadoc warnings? Did the
tests succeed? Does the demo application work correctly? Does Test2BTerms pass?
+  1. Examine the results. Did it build without errors? Were there Javadoc warnings? Did the
tests succeed? Does the demo application work correctly? Does Test2BTerms pass (this takes
a lot of memory)?
   1. Remove {{{lucene/benchmark/{work,temp}/}}} if present
   1. Build as defined below in the "Building the Release Artifacts" section.
   1. If during the feature freeze phase bug fixes are committed to the X.Y branch then build
another release candidate and announce on dev@ and java-user@ that everyone should use the
new RC for testing.
@@ -70, +70 @@

  
  If after the last day of the feature freeze phase no blocking issues are in JIRA with "Fix
Version" X.Y then it's time to build the release artifacts.
  
-  1. It is recommended to clean your Ivy cache by executing {{{rm -rf ~/.ivy2/cache}}} before
building the artifacts. This ensures that all Ivy dependencies are freshly downloaded, so
we emulate a user that never used the Lucene build system before (this step ensures downloadability
of all artifacts).
+  1. It is recommended to clean your Ivy cache by executing {{{rm -rf ~/.ivy2/cache}}} before
building the artifacts. This ensures that all Ivy dependencies are freshly downloaded, so
we emulate a user that never used the Lucene build system before (this step ensures downloadability
of all artifacts). If you have a ton of stuff in your ivy cache, it's a good idea to move
the cache temporarily to another location and restore it after the RC has been built so you
wouldn't have to download everything again.
   1. Option 1 (recommended): use {{{dev-tools/scripts/buildAndPushRelease.py}}} to build
a release candidate and stage the results locally. Run {{{buildAndPushRelease.py}}} with {{{
--help }}} to learn the available options. Here's an example of what was done for the 5.1
release:
      a. Build the release candidate: {{{python3 -u dev-tools/scripts/buildAndPushRelease.py
--push-local /tmp/releases/5.1 --rc-num 2 /complete/path/to/svn/checkout/of/releasebranch}}}
      a. Optionally, run the smoke test script against the local release candidate: {{{python3
-u dev-tools/scripts/smokeTestRelease.py /tmp/releases/5.1/lucene-solr-5.1.0-RC2-rev1672403}}}
@@ -108, +108 @@

  python3 -u dev-tools/scripts/smokeTestRelease.py
  https://dist.apache.org/repos/dist/dev/lucene/lucene-solr-5.1.0-RC2-rev1672403/
  
- Here's my +1 
+ Here's my +1
  SUCCESS! [0:43:35.208102]
  }}}
   1. If the key you used to sign the release candidate artifacts has not been signed by other
Apache committers, then testers may see the following warning:
@@ -128, +128 @@

  }}}
  
   1. If this is a point release, copy the CHANGES.txt entry for this point release back to
the trunk's CHANGES.txt. Remove any duplicate entries from trunk's CHANGES.txt (ie, each issue
should appear only once, in the earliest point-release that contains the fix, on the assumption
that all future releases also contain the fix).
-  1. Delete the maven artifacts from the staging repo (assuming you still have them locally);
if you don't have the maven directories locally, you'll need to download them from subversion
before deleting.
+  1. Delete the maven artifacts from the staging repo (assuming you still have them locally);
if you don't have the maven directories locally, you'll need to download them from subversion
before deleting. Also delete any failed RCs that didn't pass the voting process from the staging
repo.
   1. Move the new release artifacts to the releases repo:
  {{{
  svn move -m "Move Lucene RC2 to release repo." https://dist.apache.org/repos/dist/dev/lucene/lucene-solr-5.1.0-RC2-rev1672403/lucene
https://dist.apache.org/repos/dist/release/lucene/java/5.1.0
@@ -170, +170 @@

   1. untar the lucene and solr release .tgz to create lucene-X.Y.Z and solr-X.Y.Z
   1. {{{cd website-production; svn update --depth=immediates core solr; cd ..}}}
   1. {{{cp -r lucene-X.Y.Z/docs website-production/core/X_Y_Z}}}
-  1. {{{svn add core/X_Y_Z}}}
+  1. {{{svn add website-production/core/X_Y_Z}}}
-  1. {{{svn commit # this might take some time: ~ 3 beers}}}
+  1. {{{svn commit website-production/core/X_Y_Z # this might take some time: ~ 3 beers}}}
   1. {{{cp -r solr-X.Y.Z/docs website-production/solr/X_Y_Z}}}
-  1. {{{svn add solr/X_Y_Z}}}
+  1. {{{svn add website-production/solr/X_Y_Z}}}
-  1. {{{svn commit # this might take some time: ~ 1 beer}}}
+  1. {{{svn commit website-production/solr/X_Y_Z # this might take some time: ~ 1 beer}}}
   1. Confirm you can browse to these directories manually, and especially that solr javadocs
link back to lucene's correctly.
  
  == Update redirect to latest Javadoc ==
@@ -229, +229 @@

  
  To print the script's usage, run it with the {{{--help}}} option: {{{python3 -u dev-tools/scripts/addBackcompatIndexes.py
--help}}}
  
- The script uses a scratch directory - {{{/tmp/lucenebwc/}}} by default if you don't specify
{{{--temp-dir DIR}}} - to store the source for the current release that it downloads, along
with the generated indexes.  This directory will be removed by the script unless you specify
the {{{--no-cleanup}}} option, which is useful when running the script on multiple branches;
in the example below, the {{{--no-cleanup}}} option is included on the non-final script invocations,
but not on the final invocation, so that the scratch directory will be cleaned up after it's
no longer needed. 
+ The script uses a scratch directory - {{{/tmp/lucenebwc/}}} by default if you don't specify
{{{--temp-dir DIR}}} - to store the source for the current release that it downloads, along
with the generated indexes.  This directory will be removed by the script unless you specify
the {{{--no-cleanup}}} option, which is useful when running the script on multiple branches;
in the example below, the {{{--no-cleanup}}} option is included on the non-final script invocations,
but not on the final invocation, so that the scratch directory will be cleaned up after it's
no longer needed.
  
  Here's an example for the 5.1.0 release: {{{
  # If this were a bugfix release, e.g. 5.1.1, on the release branch we would first run addVersion.py
@@ -237, +237 @@

  #
  #    cd /path/to/lucene/dev/branches/lucene_solr_5_1
  #    svn up && svn stat   # Make sure there are no uncommitted changes
- #    java7    # aliased to: export JAVA_HOME="$JAVA7_HOME" ; export PATH="$JAVA7_HOME/bin:$PATH"

+ #    java7    # aliased to: export JAVA_HOME="$JAVA7_HOME" ; export PATH="$JAVA7_HOME/bin:$PATH"
  #    ant clean
  #    python3 -u dev-tools/scripts/addVersion.py 5.1.2  # Add the next version after the
current release
  #    svn ci -m "Add version 5.1.2"
@@ -250, +250 @@

  
  cd /path/to/lucene/dev/branches/branch_5x
  svn up && svn stat   # Make sure there are no uncommitted changes
- java7     # aliased to: export JAVA_HOME="$JAVA7_HOME" ; export PATH="$JAVA7_HOME/bin:$PATH"

+ java7     # aliased to: export JAVA_HOME="$JAVA7_HOME" ; export PATH="$JAVA7_HOME/bin:$PATH"
  ant clean
  python3 -u dev-tools/scripts/addBackcompatIndexes.py --no-cleanup 5.1.0
  svn add lucene/backward-codecs/src/test/org/apache/lucene/index/index.5.1.0-*.zip
@@ -259, +259 @@

  
  cd /path/to/lucene/dev/trunk
  svn up && svn stat   # Make sure there are no uncommitted changes
- java8     # aliased to: export JAVA_HOME="$JAVA8_HOME" ; export PATH="$JAVA8_HOME/bin:$PATH"

+ java8     # aliased to: export JAVA_HOME="$JAVA8_HOME" ; export PATH="$JAVA8_HOME/bin:$PATH"
  ant clean
  python3 -u dev-tools/scripts/addBackcompatIndexes.py 5.1.0
  svn add lucene/backward-codecs/src/test/org/apache/lucene/index/index.5.1.0-*.zip

Mime
View raw message