NeoOffice 2.1 Release Tasks

From NeoWiki

Revision as of 00:36, 20 March 2007 by ( | contribs)
Jump to: navigation, search

This page is an attempt to document all of the tasks required to release NeoOffice 2.1. This page is by no means comprehensive, but hopefully as we work through the release process, we will leave behind enough details to make future releases simpler and less error prone.

Here is what the colors mean:

Not yet assigned
Assigned but not yet due


Contents

Builds

In this release, there is no change in the OpenOffice.org tag that we are using so this build is far simpler than the NeoOffice 2.1 Early Access build. However, in order to fix a few ooo-build bugs found in NeoOffice 2.1 Early Access, we need to upgrade to a newer ooo-build tag. Also, we are going to bundle the latest Akua icon set. These two changes will mean that in this release, there will not be a patch that upgrades a NeoOffice 2.1 Early Access installation.

TaskDue DateAssignedStatus

Create NeoOffice-2_1_Early_Access_branch branch from the HEAD branch for NeoOffice 2.1 Early Access so that we can continue to do bug fixes and release Patches while we aer working on this release.

Note: After creating the branch, I invoked the following command in my NeoOffice 2.1 Early Access workspace to ensure that I don't accidently pull NeoOffice 2.1 changes into my build: cvs update -r NeoOffice-2_1_Early_Access_branch

03/13/07plubyDone

Perform a clean checkout of the HEAD branch and set build to build with a new version and NeoOffice trademarked product name.

This includes the following steps:

  • Perform a clean checkout of the HEAD branch
  • Copy custom.neo.mk file to custom.mk so that the clean checkout will build with the trademarked product name
  • In makefile, change the following macros to the respective values:

    PRODUCT_VERSION=2.1
    PRODUCT_DIR_VERSION=2.1
    PRODUCT_PATCH_VERSION=Patch 0
    PRODUCT_DIR_PATCH_VERSION=Patch-0
    NEO_TAG:=-rHEAD
    
  • In this release, there will not be a patch that upgrades a NeoOffice 2.1 Early Access installation so reduce the size of future patches by removing any libraries other than libvcl*.dylib from the build.patch_package target in the makefile
  • Commit makefile changes and invoke make build.oo_checkout to checkout the OpenOffice.org code
03/14/07plubyDone

Upgrade the build to use ooo-build's newer OOO_BUILD_2_1_7 tag.

TODO: Fill in detail steps that I performed

03/14/07plubyDone

Perform a clean checkout and build of the HEAD branch on Mac OS X 10.4 Intel with gcc 4.0.1.

Note: don't forget to copy custom.neo.mk file to custom.mk so that the clean checkout will build with the trademarked product name

03/14/07plubyDone

Perform a clean checkout and build of the HEAD branch on Mac OS X 10.4 PowerPC with gcc 3.3.

Note: don't forget to copy custom.neo.mk file to custom.mk so that the clean checkout will build with the trademarked product name

03/16/07OPENSTEP

Done

3/17/07

Verify that none of the Intel build's executables or libraries link to any X11 libraries.

Note: to do this task, install your latest NeoOffice build and, in a terminal, execute the following commands:

sh
cd /Applications/NeoOffice.app/Contents/MacOS
for i in `find . -type f`; do echo $i ; otool -L $i 2>&1 | grep X11; done

If none of the binaries link to any X11 libraries, the above commands will only print a list of files. However, if you see any lines that look similar to the following, the file listed just before this type of line is linked to an X11 library and this must be correct before the NeoOffice binaries can be released.

/usr/X11R6/lib/libX11.6.dylib (compatibility version 6.2.0, current version 6.2.0)
03/16/07plubyDone

Verify that none of the PowerPC build's executables or libraries link to any X11 libraries.

Note: Use the same steps as used for the matching Intel task.

03/16/07OPENSTEP

Done

No X11 Dependencies

3/17/07

Modify and test bin/installutils* sripts to not treat NeoOffice 2.1 Early Access as a match.

In this release, we do not want the installer to preserve the Early Access language pack resource files as some are incompatible with this build and will show as blank text. Also, we don't want the language pack or patch installer to upgrade an Early Access installation as it corrupt that installation.

Note: I tested this code by building the installer, language packs, and patch installer and then doing the following steps:

  • Install the patch installer and verify that it does not upgrade my NeoOffice 2.1 Early Access installation.
  • Install a NeoOffice 2.1 Early Access language pack, change my machine's preferred language to match the installed language pack, run NeoOffice 2.1 Early Access, and verify that the menus are not English.
  • With the same preferred language set in the previous step, install NeoOffice 2.1, and verify that the menus are in English.
  • Install a NeoOffice 2.1 language pack, change my machine's preferred language to match the installed language pack, run NeoOffice 2.1, and verify that the menus are not in English and verify that bug 2201 no longer occurs.
03/15/07plubyDone

Change the order in the makefile in which icon files in etc/package are added to the installer's share/config/images*.zip files etc/package in the following sequence:

  • Apply etc/package/neo2toolbarv10.zip to all share/config/images*.zip files.
  • Apply images/svx and images/svtools files in the etc/package/NeoOfficeAquaElements.zip to only the share/config/images.zip file
  • Apply any images/svx and images/svtools files in the etc/package/NeoOfficeAquaElements.zip file that also exist in the etc/package/neo2toolbarv10.zip to all of the share/config/images*.zip files except share/config/images.zip.
  • Apply images/svx and images/svtools files in the etc/package/AkuaIcons.zip to only the share/config/images.zip file
  • Apply any images/svx and images/svtools files in the etc/package/AkuaIcons.zip file that also exist in the etc/package/neo2toolbarv10.zip to all of the share/config/images*.zip files except share/config/images.zip.
03/16/07plubyDone

Commit and test updated icon files in etc/package.

  • cd etc/package
  • Execute the following shell script:
    #!/bin/csh
    #
    # execute within etc/package directory
    
    setenv PKGDIR `pwd`
    
    pushd ~
    curl -C - -O http://homepage.mac.com/punto_mac/projects/neo/downloads/Akua_March_Release.dmg
    popd
    
    setenv VOL `hdiutil mount ~/Akua_March_Release.dmg | perl -ne 'if ( /(\/Volumes.*)$/ ) { print $1; }'`
    if ( "$VOL" != "" ) then
    	mkdir "Akua Beta Release"
    	pushd "$VOL"
    	cp -rf * "$PKGDIR/Akua Beta Release"
    	popd
    	pushd "Akua Beta Release"
    	find . -type f -name \.\* -print0 | xargs -0 -n 1 rm -f
    	popd
    	
    	if ( -e AkuaIcons.zip ) then
    		rm AkuaIcons.zip
    	endif
    	zip -r AkuaIcons.zip "Akua Beta Release"
    	hdiutil unmount "$VOL"
    	rm -rf "Akua Beta Release"
    endif
    
    setenv VOL ""
    
    pushd ~
    curl -C - -O http://www.pimley.net/projects/downloads/NeoOfficeAquaElements.dmg
    popd
    
    setenv VOL `hdiutil mount ~/NeoOfficeAquaElements.dmg | perl -ne 'if ( /(\/Volumes.*)$/ ) { print $1; }'`
    if ( "$VOL" != "" ) then
    	mkdir "NeoOffice Aqua Elements 2.1.020211"
    	pushd "$VOL"
    	cp -rf * "$PKGDIR/NeoOffice Aqua Elements 2.1.020211"
    	popd
    	pushd "NeoOffice Aqua Elements 2.1.020211"
    	find . -type f -name \.\* -print0 | xargs -0 -n 1 rm -f
    	popd
    	
    	if ( -e NeoOfficeAquaElements.zip ) then
    		rm NeoOfficeAquaElements.zip
    	endif
    	zip -r NeoOfficeAquaElements.zip "NeoOffice Aqua Elements 2.1.020211"
    	hdiutil unmount "$VOL"
    	rm -rf "NeoOffice Aqua Elements 2.1.020211"
    endif
    
  • Rebuild installer with new icon zip files and verify proper build.
  • Reinstall and check that updated icons are available.
03/16/07OPENSTEPDone

Get latest version of DicOOo.sxw and FontOOo.sxw files, replace all references to the Control key with the Command key, and commit files in etc/share/dict/ooo.

Note: to do this task, do the following steps:

  • Download the latest DicOOo.sxw file from here
  • Create a new directory and in that directory, unzip the downloaded file using the zip command.
  • Change all of the Windows carriage returns in the unzipped files to Unix newlines and ensure that the files end with a Unix newline by executing the following command:
  • sh
    for i in `find /path/to/first/directory -name content.xml -o -name "Translation*.xml"`; do
    ( cat $i ; echo ) | tr '\r' '\n' > $i.tmp
    mv -f $i.tmp $i
    done
    
  • Replace all known references to the Control key with the Command key and replace OpenOffice.org with NeoOffice in the first directory by executing the following command:
  • sh
    for i in `find /path/to/first/directory -name content.xml -o -name "Translation*.xml"`; do
    cat $i | \
    sed 's#\[CTRL\]#[Command]#g' | \
    sed 's#\[Ctrl\]#[Command]#g' | \
    sed 's#\[ctrl\]#[Command]#g' | \
    sed 's#\[Strg\]#[Command]#g' | \
    sed 's# CTRL #[Command]#g' | \
    sed 's#\(Ctrl\)#[Command]#g' | \
    sed 's#«Ctrl»#[Command]#g' | \
    sed 's#OpenOffice\.org#NeoOffice#g' | \
    sed 's#OpenOffice#NeoOffice#g' | \
    sed 's#/NeoOfffice/#/OpenOffice.org/#g' > $i.tmp
    mv -f $i.tmp $i
    done
    
  • Replace the etc/share/dict/ooo/DicOOo.sxw file by executing the following commands:
  • sh
    cd /path/to/first/directory
    zip -r /path/to/etc/share/dict/ooo/DicOOo.sxw .
    
  • Copy your etc/share/dict/ooo/DicOOo.sxw into your latest NeoOffice installation and run the wizard to verify that the modified file actually works and that the text has been properly changed before commiting the modified file.
  • Download the latest FontOOo.sxw file from here and repeat the above steps by replacing "DicOOo" with "FontOOo".
03/16/07plubyDone

Merge any NeoOffice 2.1 Early Access bug fixes committed to the NeoOffice-2_1_Early_Access_branch branch.

Note: As of 03/15/2007, I have already merged the fixes included in NeoOffice 2.1 Early Access Patch 2 Test 1. On 03/17/2007 I refixed bug 1971 in vcl module.

03/18/07plubyDone

Tag the code in the HEAD branch with the NeoOffice-2_1 tag.

Note: Because the installer build checks out source code from the anoncvs.neooffice.org server, the following steps must be done to complete this task properly:

  • Do a cvs update -Ad to ensure that you have the latest code in your workspace, verify that none of the files are marked as updated, patched, modified, or have conflicts, and verify that the latest code actually builds through the installer.
  • In the makefile, set the NEO_TAG macro to NEO_TAG:=-rNeoOffice-2_1 and commit the makefile.
  • Tag all files in your workspace by invoking cvs tag NeoOffice-2_1.
  • On the cvs.neooffice.org server, run the script to synchronize the anoncvs.neooffice.org server.
  • Verify that the installer still builds by deleting the build.source_zip file and invoking make NOLANGPACKS=true.
  • If there are any build errors, fix and commit them, retag the changed files by invoking cvs tag -F NeoOffice-2_1, and repeating the previous two steps.
03/18/07OPENSTEP

Done

3/18/07

Create releasable NeoOffice 2.1 build for Intel.

Note: the following steps are overkill, but they ensure that all recent changes to the NeoOffice custom code has been built:

  • Do a cvs update -d -rNeoOffice-2_1 and verify that none of the files are marked as updated, patched, modified, or have conflicts. If any such errors appear, the previous task (tagging of the workspace) has not been done properly and it needs to done properly before you can proceed with this task.
  • Do a cvs update -Ad so that you can do bug fixing and release patches after you create your releasable build
  • Delete all build.neo_* and build.odf-converter* files. This will force the installer to rebuild the odf-converter code and all of the NeoOffice custom code without causing any of the OpenOffice.org or ooo-build code to be rebuilt.
  • Invoke make to create the releasable installer and language packs.
03/19/07plubyDone

Create releasable NeoOffice 2.1 build for PowerPC.

Note: Use the same steps as used for the matching Intel task.

03/19/07OPENSTEPDone

Create backup copy of releasable Intel binaries and upload them to staging server.

The following steps are the steps that I used to create my backup copy:

  • Create an empty NeoOffice-2.1 directory outside of the workspace
  • Copy all 58 install/*.dmg files from your releasable build into the empty NeoOffice-2.1 directory and chmod 444 *.dmg in that directory
  • Create a CD master NeoOffice-2.1.cdr file of the NeoOffice-2.1 directory using the following command:
  • hdiutil create -srcfolder /path/to/NeoOffice-2.1/directory \
    -format UDTO -ov -o /path/to/output/NeoOffice-2.1.cdr
    

sftp all 58 files up to staging server and chmod 444 *.dmg all of the files on the staging server.

diff the ls -l *Intel.dmg | awk '{print $9 " " $5} | sort' output of the files on the server and in local NeoOffice-2.1 directory.

03/19/07plubyDone

Create backup copy of releasable PowerPC binaries and upload them to staging server.

Note: Use the same steps as used for the matching Intel task (except diff using ls -l *PowerPC.dmg | awk '{print $9 " " $5} | sort'.

03/19/07OPENSTEP

Done

3/19/07

Verify that the releasable installer and one or more language packs install and run on Intel for the following Mac OS X versions:

  • 10.4.9
  • 1 March 2007 10.5.0 developer seed
03/19/07plubyDone

Verify that the releasable installer and one or more language packs install and run on PowerPC for the following Mac OS X versions:

  • 10.3.9
  • 10.4.9
  • 1 March 2007 10.5.0 developer seed
03/19/07plubyDone

Website

TaskDue DateAssignedStatus

Since we are dropping support of NeoOffice 1.2.2 and no longer doing CD sales, remove all pages and links to these in the download.neooffice.org website.

Note: here are the overall changes that I made:

  • cvs remove all files having the name old* or *cd*.
  • Delete all links to the pages deleted in the last step found using the following commands:
  • grep -r '<a href=".*cd.*">' *
    grep -r '<a href="old.*">' *
    
  • Commit the changes and cvs update -Ad on both of the www.planamesa.com and www.neooffice.org servers.
  • Remove any invocations of the bin/shuffle.sh script against any of the deleted files using crontab -e on both servers.
03/14/07plubyDone

Create 2.1 Early Access branch. This branches the existing website to avoid modifying existing website while it is live. Steps:

  • Construct a local checkout of the website: cvs co web/src/www.
  • cvs tag -b NeoOffice-2_1_Early_Access_branch web/src/www
  • Login to www.planamesa.com
  • cd www
  • cvs update -d -rNeoOffice-2_1_Early_Access_branch
  • Login to hotspare www.neooffice.org
  • cd /var/www/htdocs/download_root/
  • cvs update -d -rNeoOffice-2_1_Early_Access_branch
03/17/07OPENSTEPDone

Migrate mirror rotation cron job to independent user account on hanuman

  • Construct cron job user account on hanuman
  • Migrate mirror rotation crontab to cron job account
  • Remove old user account crontab entry
03/26/2007OPENSTEP

Update all version names, file URLs, and patch version in all of the earlyaccess*.php files in the download.neooffice.org web pages.

Note: I used the following steps to do this:

  • Update the version name and file URLs by executing the following commands in the neojava directory of the web pages. Important: the script excludes the earlyaccess.php page as we do not want to remove "Early Access" from those pages:
  • sh
    for i in `find . -name "earlyaccess*.php" -o -name "header.html" | grep -v "earlyaccess\.php"`; do
    sed 's#NeoOffice 2\.1 Early Access#NeoOffice 2.1#g' $i | \
    sed 's#_Early_Access##g' > $i.tmp
    mv $i.tmp $i
    done
    
  • Manually edit the neojava/welcomelog.php page and add NeoOffice 2.1 as another element in the $logproducts array.
  • Reset the patch version to "Patch 0" by executing the following commands in the neojava directory of the web pages.
  • sh
    for i in `find . -name "earlyaccesspatch.php" -o -name "header.html"`; do
    sed 's#Patch 2#Patch 0#g' $i | \
    sed 's#Patch-2#Patch-0#g' > $i.tmp
    mv $i.tmp $i
    done
    
  • Manually edit all of the earlyaccesspatch.php pages, uncomment the last table row (the one that says "No patches have been released") and comment out the other two table rows (the PowerPC and Intel patch links).
  • Manually edit the neojava/donateredirect.php page, set $earlyaccessproduct to NeoOffice 2.1, set $earlyaccessproductfamily[0] to NeoOffice 2.1 Early Access, and set $earlyaccesspatch to Patch 0.
03/19/2007plubyDone

Update the 114 language packs' file sizes in all of the earlyaccessdownload.php files in the download.neooffice.org web pages.

Note: I used the following steps to do this:

  • Get a file containing the new release's file names and the matching file sizes from the NeoOffice 2.1 Early Access release by executing the following command:
  • ls -l /directory/NeoOffice-2.1_Early_Access/binaries/*Language_Pack*.dmg | awk '{print $9 " " $5}' | sed 's#^.*NeoOffice-2.1_Early_Access#NeoOffice-2.1#' | sort > /path/to/a/new/file
    
  • Get a file containing the new release's file names and the matching file sizes by executing the following commands:
  • ls -l /directory/NeoOffice-2.1/binaries/*Language_Pack*.dmg | awk '{print $9 " " $5}' | sort > /path/to/a/new/file
    
  • Create a chained list of sed commands by executing the following command:
  • join /file/from/first/step /file/from/second/step | sed 's#^.*dmg ##' | sed 's# #\##' | sed 's#^#sed "s\##' | sed 's#$#\#g" | \\#' > /path/to/a/new/file
    
  • Manually edit the file created in the last step and insert the following lines before the first sed command:
  • for i in `find . -name "earlyaccessdownload.php" -o -name "header.html"`; do
    cat $i | \
    
  • Manually edit the same file and insert the following lines after the last sed command:
  • cat > $i.tmp
    mv $i.tmp $i
    done
    
  • cd to the neojava directory and execute the following command to update all of the file sizes:
  • sh /path/to/file/edited/in/last/step
    
03/19/07plubyDone

Create a 2.1 Early Access 2 branch. This branches the existing website to avoid modifying existing website while it is live. Important: do not cvs update either of the www.planamesa.com or www.neooffice.org servers. That will be done as part of the Pre-Release tasks. Steps:

  • Construct a local checkout of the website: cvs co web/src/www.
  • cvs tag -b NeoOffice-2_1_Early_Access_2_branch web/src/www
03/19/07plubyDone

Merge the updates made to the Early Access pages in the download.neooffice.org web pages to their matching regular pages.

Note: use the following steps to complete this task:

  • Copy the applicable Early Access pages to their matching regular page by executing the following commands within the neojava directory:
  • sh
    for i in `find . -name "build.php" -o -name "download.php" -o -name "features.php" -o -name "patch.php"`; do
    cp `dirname $i`/earlyaccess`basename $i` $i
    done
    
  • Replace any Early Access links in the regular pages that were overwritten in the previous step by executing the following commands within the neojava directory:
  • sh
    for i in `find . -name "build.php" -o -name "download.php" -o -name "features.php" -o -name "patch.php"`; do
    sed 's#href="earlyaccess#href="#g' $i > $i.tmp
    mv $i.tmp $i
    done
    
  • Manually edit all of the download.php pages, put back the old <a name="download"> section, change any NeoOffice 2.0 Aqua Beta 3 or NeoOffice 2.0 Aqua B 3 references to NeoOffice 2.1, change any NeoOffice-2.0_Aqua_Beta_3 references to NeoOffice-2.1, and update the two file sizes in this section to the new file sizes.
  • Manually edit all of the header.html pages, uncomment the "Download NeoOffice 2.1 for free" table row, and comment out all of the other Early Access table rows.
  • Manually edit the neojava/welcomelog.php page, delete all of the $logproducts array elements except the first, and set the first to an empty string.
  • Manually edit the neojava/donateredirect.php page, set $earlyaccessproduct to an empty string, set $earlyaccessproductfamily[0] to an empty string, set $currentproduct to NeoOffice 2.1 and set $currentpatch to Patch 0.
03/23/2007OPENSTEP

Mirrors

NeoOffice's rsync server is hosted by HeapSys and our volunteer mirrors obtain the NeoOffice binaries by nightly runs of the following command on their mirrors:

rsync -r --delete rsync://www.heapsys.com/ftp/ /path/to/NeoOffice/mirror/directory
TaskDue DateAssignedStatus
Notify the rsync server and mirror maintainers that we will be pushing new binaries out to them a few days before the 27 March 2007 release date so that they can prepare for the huge surge in bandwidth usage that their servers will get in the first month or so after reelease. 03/12/07plubyDone

Remove NeoOffice 1.2.2 binaries from mirrors after completing the removal of the links NeoOffice 1.2.2 download pages from the download.neooffice.org website (see Website section on this page for that task).

Note: the following steps were used to complete this task:

  • Delete all *1.2.2*.dmg files from both of the www.planamesa.net and www.planamesa.org servers.
  • Contact the rsync server maintainer and have them delete all *1.2.2*.dmg files on the rsync server.
  • After the files have been deleted from the rsync server, wait 48 hours and verify that these files have been deleted from the mirrors listed in the download.neooffice.org website's neojava/mirrors.php file.
  • Contact any mirror maintainers that still have these files to confirm that they are rsynching to the rsync server regularly.
03/16/07plubyDone
Provide list of URLs of binaries and their respective file sizes to the rsync server maintainer so that the rsync server can copy them to the rsync server. 03/21/07
Verify that the binaries are available from the rsync server and verify that each of the mirrors has synched them to their site. Try to contact any mirrors that have not synched to see if their is any problem or if the site can no longer be a mirror. 03/23/07

Pre-Release to Early Access Members

TaskDue DateAssignedStatus
Copy the 2 NeoOffice 2.1 main installer NeoOffice-2.1-*.dmg files from the staging area into the Early Access system's download directory on the eap.neooffice.org server and chmod 444 both files. Important: these 2 files are restricted to Early Access members only and they should not be copied into any public directories. 03/19/07
Copy the 114 NeoOffice 2.1 language pack installer NeoOffice-2.1-Language_Pack*.dmg files from the staging area into the neojava/downloads directory on the eap.neooffice.org server and chmod 444 all the files in that directory. Since these installers are useless without having already installed NeoOffice 2.1, it is OK that these files are in a public directory. 03/19/07
Delete the 2 NeoOffice 2.1 Early Access main installer *.dmg files from the Early Access system's download directory on the eap.neooffice.org server. 03/21/07
Delete the 2 obsolete NeoOffice 2.1 Early Access language pack installer NeoOffice-2.1_Early_Access-*.dmg files from the neojava/downloads directory on the eap.neooffice.org server. 03/21/07
Add "2.1" as a version in Bugzilla. 03/21/07

Close all bugs with a status of "Resolved" by setting the following field values:

  • Set "Status" field to "Closed"
  • Set "Resolution" field to "Fixed"
  • Set "Target Version" field to "2.1"
  • Set "Closed in Version" field to "2.1"
03/21/07
Delete the 114 obsolete NeoOffice 2.1 Early Access language pack installer NeoOffice-2.1_Early_Access-Language_Pack*.dmg files from the neojava/downloads directory on the eap.neooffice.org server. 03/21/07
Delete the 2 obsolete NeoOffice 2.1 Early Access patch installer NeoOffice-2.1_Early_Access-Patch-*.dmg files from the neojava/downloads/patches directory on the eap.neooffice.org server. 03/21/07

Release

Personal tools