Mailing-List: contact java-commits-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Apache Wiki <wikidiffs@apache.org>
To: Apache Wiki <wikidiffs@apache.org>
Date: Sat, 26 Mar 2011 11:48:43 -0000
Message-ID: <20110326114843.11679.69819@eosnew.apache.org>
Subject: =?utf-8?q?ReleaseTodo_reverted_to_revision_97_on_Lucene-java_Wiki?=

Dear wiki user,

You have subscribed to a wiki page "Lucene-java Wiki" for change notificati=
on.

The page ReleaseTodo has been reverted to revision 97 by GrantIngersoll.
http://wiki.apache.org/lucene-java/ReleaseTodo?action=3Ddiff&rev1=3D98&rev2=
=3D99

--------------------------------------------------

  https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr_X_Y -m "=
Starting Lucene/Solr X.Y branch."
  }}}
   1. After branching the new release series, update the default version in=
 lucene/common-build.xml on trunk to X.Y+1-dev and the default version in l=
ucene/common-build.xml on the branch to X.Y (remove the -SNAPSHOT suffix). =
Also update the LUCENE_MAIN_VERSION in src/java/org/apache/lucene/util/Cons=
tants.java. Also add the new enum constant into src/java/org/apache/lucene/=
util/Version.java. Update src/test/org/apache/lucene/util/LuceneTestCase.ja=
va to use the current version.
-  1. Prepare the backwards-compatibility tests in trunk (only if a new maj=
or release was started a
+  1. Prepare the backwards-compatibility tests in trunk (only if a new maj=
or release was started and you created the branch before):
+  {{{
+ svn rm backwards/src/
+ svn cp https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr_X=
_Y/lucene/src/ backwards/src/
+ ant test-backwards
+ }}}
+  1. On trunk, fix src/site/src/documentation/content/xdocs/{tabs.xml,inde=
x.xml} to reference the X.Y+1-dev version. Rebuild the website (http://wiki=
.apache.org/lucene-java/HowToUpdateTheWebsite) and commit.
+  1. On the branch, fix the same files, rebuild the website and commit.
+  1. Send a note to dev@ to inform the committers that the branch has been=
 created and the feature freeze phase has started. Include Do's and Don'ts =
for the feature freeze phase:
+   * No new features may be committed to the branch.
+   * Documentation patches, build patches and serious bug fixes may be com=
mitted to the branch. However, you should submit *all* patches you want to =
commit to Jira first to give others the chance to review and possibly vote =
against the patch. Keep in mind that it is our main intention to keep the b=
ranch as stable as possible.
+   * All patches that are intended for the branch should first be committe=
d to trunk and then merged into the branch.
+   * Normal trunk development may continue as usual. However, if you plan =
to commit a big change to the trunk while the branch feature freeze is in e=
ffect, think twice: can't the addition wait a couple more days? Merges of b=
ug fixes into the branch may become more difficult.
+   * *Only* Jira issues with Fix version "X.Y" and priority "Blocker" will=
 delay a release candidate build.
  =

+ =3D Release Workflow =3D
+  1. Check out the branch with: {{{svn co https://svn.apache.org/repos/asf=
/lucene/dev/branches/lucene_solr_X_Y}}}
+  1. Add an entry for the new version in the doap.rdf file, stored under d=
ocs/doap.rdf in the unversioned site (see http://wiki.apache.org/lucene-jav=
a/HowToUpdateTheWebsite).
+  1. If the release is < 3.0, ensure "ant test-core" passes in a 1.4 Java =
environment. Important: Do two tests: Compile & test with Java 1.4, but als=
o compile with Java 5 and only run tests with 1.4. This ensures, that the a=
rtifacts are really working with Java 1.4 (see the comment [[https://issues=
.apache.org/jira/browse/LUCENE-2285?focusedCommentId=3D12839224&page=3Dcom.=
atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_1283922=
4|https://issues.apache.org/jira/browse/LUCENE-2285?focusedCommentId=3D1283=
9224&page=3Dcom.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpa=
nel#action_12839224]] for explanation).
+  1. Build the code and javadocs, and run the unit tests: ant clean javado=
cs test
+  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. Remove contrib/benchmark/{work,temp} if present
+  1. Build as defined below in the "Building the Release Artifacts" sectio=
n.
+  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.
+  1. Call a release vote on java-dev and cc general@lucene.apache.org .
+ =

+ =3D Building the Release artifacts =3D
+  1. 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 arti=
facts
+  1. Verify that "svnversion" reports a single revision with no modified c=
hanges
+  1. Remove contrib/benchmark/{work,temp} if present
+  1. Build the release artifacts: {{{ant -Dversion=3DX.Y.Z }}}[-Dgpg.exe=
=3D/path/to/gpg -Dgpg.key=3DYourKeyID -Dgpg.passphrase=3DYourPassPhrase{{{]=
 prepare-release  //Items in [] may be optional}}}
+  1. Sanity check the overall size of each artifact. EG, compare to the la=
st release.
+  1. Make sure that for each release file an md5 checksum file exists.
+  1. ant -Dversion=3DX.Y.Z copy-to-stage to move the artifacts up to the s=
taging area (see the build target for all the options for securly copying t=
he artifacts up)
+ =

+ =3D Publishing =3D
+ Once [[http://www.apache.org/foundation/voting.html#ReleaseVotes|three PM=
C members have voted for a release]], it may be published.
+ =

+  1. Tag the release:
+  {{{
+ svn copy https://svn.apache.org/repos/asf/lucene/dev/branches/lucene_solr=
_X_Y \
+ https://svn.apache.org/repos/asf/lucene/java/tags/lucene_solr_X_Y_Z -m "L=
ucene Java X.Y.Z release."
+ }}}
+  1. If this is a new branch (ie you are releasing X.Y.0), after tagging, =
commit a new "unreleased" section at the top of CHANGES.txt and contrib/CHA=
NGES.txt onto the branch
+  1. If this is your first release, add your key to the KEYS file. The KEY=
S file is located in Subversion at [WWW] https://svn.apache.org/repos/asf/l=
ucene/java/dist and copy it to the release directory. Make sure you commit =
your change.
+  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 earlie=
st point-release that contains the fix, on the assumption that all future r=
eleases also contain the fix).
+  1. See [[http://jakarta.apache.org/site/convert-to-mirror.html?Step-By-S=
tep|Guide To Distributing Existing Releases Through The ASF Mirrors]] and t=
he links that are there.
+  1. Copy the KEYS file, and the non-Maven release artifacts to the dist d=
irectory {{{people.apache.org:/www/www.apache.org/dist/lucene/java}}}, and =
remove the old files
+  1. Make sure the group ownership on the site is 'lucene' by calling {{{c=
hgrp -R lucene /www/www.apache.org/dist/lucene/java}}}. Also make files gro=
up writable and others read-only by calling {{{chmod -R g+w,o-w /www/www.ap=
ache.org/dist/lucene/java}}}
+  1. Copy the Maven artifacts to the distribution directory (follow the ex=
isting directory structure), to have them pushed to the central Maven repos=
itories: {{{people.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-=
repository/org/apache/lucene}}}
+  1. Make sure the group ownership on the site is 'lucene' by calling {{{c=
hgrp -R lucene /www/people.apache.org/repo/m2-ibiblio-rsync-repository/org/=
apache/lucene}}}. Also make files group writable and others read-only by ca=
lling {{{chmod -R g+w,o-w /www/people.apache.org/repo/m2-ibiblio-rsync-repo=
sitory/org/apache/lucene}}}
+  1. Checkout https://svn.apache.org/repos/asf/lucene/java/nightly and upd=
ate VERSION=3DX.Y-$BUILD_ID in hudson-lucene-X.x.sh . See http://wiki.apach=
e.org/general/Hudson for how to get a login on Jenkins (formerly Hudson), o=
r ask Grant or Michael B. for help.
+  1. Wait 24 hours to give the mirrors a chance to get the new release.
+ =

+ =3D Announcing =3D
+  1. Checkout the top-level Lucene website from https://svn.apache.org/rep=
os/asf/lucene/site. Add a new item under "News", in index.xml. Run "forrest=
 site", confirm all looks good, then recursively copy build/site/* to publi=
sh/*, then commit the changes. Then copy publish/* to /www/lucene.apache.or=
g/* on people.apache.org. Be sure to change the group and attributes of the=
 copied files: {{{cd /www/lucene.apache.org/; chown lucene * images/* skin/=
*; chmod g+w,o-w * images/* skin/*}}}.
+  1. Checkout the Lucene java website from https://svn.apache.org/repos/as=
f/lucene/java/site. Add a new item under "Lucene News", in index.xml. Add a=
 new entry for this release into both tabs.xml and site.xml. Run "forrest s=
ite", confirm all looks good, and recursively copy build/site/* to docs/*, =
then commit the changes. Copy docs/* to /www/lucene.apache.org/java/docs on=
 people.apache.org. Make sure .htaccess is copied!
+  1. Copy the release specific docs to people.apache.org:
+  {{{
+   ssh people.apache.org
+   tar xzf lucene-X.Y.Z.tar.gz lucene-X.Y.Z/docs
+   mv lucene-X.Y.Z/docs /www/lucene.apache.org/java/X_Y_Z
+   rmdir lucene-X.Y.Z
+ }}}
+  1. Make sure the group ownership on the site is 'lucene' by calling {{{c=
hgrp -R lucene /www/lucene.apache.org/java}}}. Also make files group writab=
le and others read-only by calling {{{chmod -R g+w,o-w /www/lucene.apache.o=
rg/java}}}.
+  1. Wait for these changes to appear on Apache's main webserver (http://l=
ucene.apache.org) before doing the next steps (see http://www.apache.org/de=
v/project-site.html for details on how the site is mirrored to Apache's mai=
n web servers). Once they appear, verify all links are correct in your chan=
ges!
+  1. Add the new version to Wikipedia (english and maybe your own language)
+  1. Announce the release on general@lucene.apache.org , java-dev@lucene.a=
pache.org , java-user@lucene.apache.org and announce@apache.org mailing lis=
ts. A draft should be sent to the development list first to clarify any pos=
sible issues in the announcement. Mails to the announce list should be sent=
 from an @apache.org email address and contain a signature.
+  1. Ensure the latest Lucene Jar + MD5 sum file have been pushed to http:=
//repo1.maven.org/maven2/org/apache/lucene/ by deploying the distribution t=
o http://people.apache.org/repo/m2-ibiblio-rsync-repository/ (that is minot=
aur.apache.org:/www/people.apache.org/repo/m2-ibiblio-rsync-repository). Fr=
om there it will be pushed to the central Maven repositories (both Maven 1 =
and Maven 2) automatically in a few hours. Contact repository@apache.org if=
 there's some problem.
+  1. Go to the JIRA "Manage Versions" Administration page (http://issues.a=
pache.org/jira/secure/project/ManageVersions.jspa?pid=3D12310110) and click=
 Release for the version you just released. Also add a new (unreleased) ver=
sion for the next release on the trunk (for a major release) or branch (for=
 a minor release).
+  1. Go to JIRA and find all issues that were fixed in the release you jus=
t made, whose Status is Resolved, and do a bulk change to close all of thes=
e issues. Uncheck the box that says "send an email for these changes".
+ =

+ =3D See Also =3D
+  * [[http://www.apache.org/dev/release.html|Apache Releases FAQ]]
+=20