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: Tue, 03 Jul 2012 08:20:42 -0000
Message-ID: <20120703082042.43768.14168@eos.apache.org>
Subject: 
 =?utf-8?q?=5BLucene-java_Wiki=5D_Update_of_=22ReleaseTodo=22_by_SteveRowe?=
Auto-Submitted: auto-generated

Dear Wiki user,

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

The "ReleaseTodo" page has been changed by SteveRowe:
http://wiki.apache.org/lucene-java/ReleaseTodo?action=3Ddiff&rev1=3D125&rev=
2=3D126

Comment:
Updated section on website update & announcing, mostly to include info abou=
t the CMS extpaths.txt facility

  =

  =3D Pushing website changes & Announcing =3D
  =

- /!\ needs heavy updating to reflect new CMS based website /!\
+ =3D=3D Website +=3D javadocs =3D=3D
+ The problem: Lucene's and Solr's voluminous per-release javadocs break th=
e standard CMS process for the website (i.e., committer commits to the sour=
ce tree; the CMS buildbot generates the site, then commits to the staging t=
ree; committer reviews and then publishes to the production tree), because =
dynamic website updates, currently scheduled at 21 minutes after the hour o=
n the hour, interrupt the extremely long commit times for javadocs being st=
aged by buildbot, resulting in failed commits, caused by conflicts with the=
 dynamic updates: by the time the buildbot-triggered commit has finished, i=
ts svn tree has been rendered stale.
  =

+ The solution: skip committing javadocs to the source tree, then staging, =
then publishing, and instead commit javadocs directly to the production tre=
e.  Ordinarily this would be problematic, because the CMS wants to keep the=
 production tree in sync with the staging tree, so anything it finds  in th=
e production tree that's not in the staging tree gets nuked.  However, the =
CMS has a built-in mechanism to allow exceptions to the keep-production-in-=
sync-with-staging rule: {{{extpaths.txt}}}.
  =

- /!\ BEGIN this info is all out of date /!\
+ {{{extpaths.txt}}} lists paths in the production tree, relative to the pr=
oject website's root directory, that are allowed to be out of sync with the=
 staging tree.
  =

+ For more info, see the following sections in the [[http://www.apache.org/=
dev/cmsref|Apache CMS Reference]]:
+  * [[http://www.apache.org/dev/cmsref#extpaths|What is extpaths.txt?]]
+  * [[http://www.apache.org/dev/cmsref#generated-docs|How do I publish gen=
erated docs (eg. doxygen)?]]
+  * A worked out example: [[http://www.apache.org/dev/cmsref#mail-link|How=
 do I make the mail archives for my TLP accessible through the /mail URL?]]
-  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/; chgrp -R lucene * ; chmod -R =
ug+w,o-w *}}}.
-  1. Checkout the unversioned Lucene java website from https://svn.apache.=
org/repos/asf/lucene/java/site. Add a new item under "Lucene News", in inde=
x.xml. Add a new entry for this release into both tabs.xml and site.xml. Ru=
n "forrest site", 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 from the binary release package to peo=
ple.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 ug+w,o-w /www/lucene.apache.=
org/java}}}.
  =

- /!\ END this info is all out of date /!\
+ =3D=3D Update extpaths.txt =3D=3D
+  1. {{{svn co --depth=3Dimmediates https://svn.apache.org/repos/asf/lucen=
e/cms/trunk/content website-source}}}
+  1. {{{cd website-source}}}
+  1. Add Lucene javadocs dir: {{{echo core/X_Y_Z >> extpaths.txt}}}
+  1. Add Solr javadocs dir: {{{echo solr/api-X_Y_Z >> extpaths.txt}}}
+  1. {{{svn commit -m "Update CMS production sync exceptions for X_Y_Z jav=
adocs" extpaths.txt}}}
+  1. {{{cd ..}}}
+  1. {{{rm -rf website-source}}}
  =

+ =3D=3D Push javadocs to the CMS production tree =3D=3D
+  1. {{{svn co https://svn.apache.org/repos/infra/websites/production/luce=
ne/content/ website-production}}}
- /!\ BEGIN vague stab at new way of doing things /!\
-  =

-  1. {{{svn co https://svn.apache.org/repos/asf/lucene/cms/trunk website}}}
   1. untar the release.tgz to create releaseX_Y_Z/
-  1. {{{cp -r releaseX_Y_Z/lucene/docs website/content/core/X_Y_Z}}}
+  1. {{{cp -r releaseX_Y_Z/lucene/docs website-production/core/X_Y_Z}}}
-  1. {{{svn add content/core/X_Y_Z}}}
+  1. {{{svn add core/X_Y_Z}}}
   1. {{{svn commit # this might take some time: ~ 3 beers}}}
-  1. {{{cp -r release_X_Y_Z/solr/docs/api website/content/solr/apiX_Y_Z}}}
+  1. {{{cp -r releaseX_Y_Z/solr/docs/api website-production/solr/api-X_Y_Z=
}}}
-  1. {{{svn add content/solr/apiX_Y_Z}}}
+  1. {{{svn add solr/apiX_Y_Z}}}
   1. {{{svn commit # this might take some time: ~ 1 beer}}}
-  1. wait till you see 2 emails on the commits@ list saying 'Staging updat=
e by buildbot for lucene'
-  1. https://cms.apache.org/lucene/publish
-  1. confirm you can browse to these directories manually, and especially =
that solr javadocs link back to lucene's correctly.
+  1. Confirm you can browse to these directories manually, and especially =
that solr javadocs link back to lucene's correctly.
-  1. once mirrors are ready, use the bookmarklet or whatever to do the min=
or changes and news blurbs and stuff.
  =

  For the 'cp' commands above, See also HowToGenerateNiceJavadocs if you op=
tionally feel like making prettier javadocs.
  But don't worry about this if it seems confusing, someone else could alwa=
ys volunteer to do it later at any time.
  =

- /!\ END vague stab at new way of doing things /!\
- =

+ =3D=3D Update the rest of the website =3D=3D
+  1. Once mirrors are ready, use the bookmarklet or whatever to do the min=
or changes and news blurbs and stuff.
   1. update the core & solr doap.rdf files to reflect the new versions usi=
ng the Apache CMS
      * https://cms.apache.org/redirect?uri=3Dhttp://lucene.apache.org/core=
/doap.rdf
      * https://cms.apache.org/redirect?uri=3Dhttp://lucene.apache.org/solr=
/doap.rdf
+  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. 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!
+ =3D=3D Announce the release =3D=3D
   1. Add the new version to Wikipedia (english and maybe your own language)
   1. Announce the release on general@lucene.apache.org , dev@lucene.apache=
.org , java-user@lucene.apache.org and announce@apache.org mailing lists. A=
 draft should be sent to the development list first to clarify any possible=
 issues in the announcement.  Make sure the announcement has a brief blurb =
at the top saying what Lucene is (it will save you several snarky comments =
in reply.) Mails to the announce list should be sent from an @apache.org em=
ail address and contain a signature.  Release announcements can be shared/e=
dited in https://svn.apache.org/repos/asf/lucene/dev/misc/announcements.
+ =

+ =3D=3D Update JIRA =3D=3D
   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".
 =20