Release process notes - Revision history

Markm: /* Uploading and Finishing Touches */

2009-05-13T01:50:40Z

Uploading and Finishing Touches

New page

I am seeding this page by jotting down notes on the process of performing the [[ReleaseNotes092|E 0.9.2 release]], as a guide to others who may do future releases or more fully automate the process (please!). This information is descriptive; not prescriptive.

At Kevin's suggestion, I did a

<code>$ svn log -r321:HEAD svn://svn.synchrona.org/erights/e/trunk</code>

to gather all the log entries since the last release. I then summarize them in the Highlights, Features, Bug Fixes, and Other Changes below.

Kevin enumerated the release blockers for the this release:
* Since r468, help(<int>) shows no methods.
* Since ???, epatt__quasiParser always throws a parse error.

Fixed them as of r635.

= Building the Release =

Once all other changes are checked in and ready to go, on a Windows Cygwin shell (with gcc and a sun jdk installed), bring all sources up to date. (svn update, etc).

In e/src/Makefile, change
<code>DOTVER=0.9.1c</code> to <code>DOTVER=0.9.2a</code>
<code>TAGVER=0_9_1c</code> to <code>TAGVER=0_9_2a</code>

The DOTVER is used to generate the names of the tarballs and the value of the <code>e.version</code> property. TAGVER is no longer used, but was used for cvs tagging.

In the "e" directory, i.e., the parent of the "e/src" directory, do

<code>$ chmod -R a+rX .
$ chmod -R u+w .
$ rm -rf classes/ dist/ export/ tarballs/
$ ls -la </code># verify the directories are actually gone.

None of the above should be necessary, but helps to work around various weirdnesses that seem to crop up on Windows, such as directories that can't be deleted. However, the permissions fixes may only be needed on systems in which [http://portal.acm.org/citation.cfm?id=1151033 Polaris] is installed.

<code>$ cd src
$ MAKE_PARSERS=true make draft tarballs
$ ls -la ../tarballs</code>

For reference, this time the output looked like

<code>$ ls -la ../tarballs
total 23888
drwxr-xr-x+ 2 Terry None 0 May 10 20:21 .
drwxr-xr-x+ 9 Terry None 0 May 10 20:17 ..
-rw-r--r-- 1 Terry None 3143728 May 10 20:21 E-purej-0.9.2a.tar.gz
-rw-r--r-- 1 Terry None 15954776 May 10 20:20 E-src-0.9.2a.tar.gz
-rw-r--r-- 1 Terry None 5353732 May 10 20:21 E-win32-x86-0.9.2a.zip</code>

Note that the <code>make</code> can take vastly longer on Windows than it does on Unix. Or maybe it's just our old PC. Or maybe it's a bad interaction with Polaris. We don't know.

For normal development, you normally don't need MAKE_PARSERS. However, this should be on when building a release and prior to the final checkin.
If the make succeeds and everything looks good, then try installing the <code>E-win32-x86-0.9.2a.zip</code> by unpacking it into a fresh directory, where you'd like E installed, such as <code>c:/Program Files/erights.org</code>. Make the directory if necessary. Double click on <code>e.jar</code>. If E installs successfully, your should see a monologue box pop up saying "Welcome to E 0.9.2a".

Run whatever other tests you need to feel comfortable that E still works after the changes since the last release. (Ideally, this would be an automated set of tests that are normally all green. We are not yet ready for that.)

If it all checks out, then do an SVN commit.

<code>$ svn ci</code>

or interactively using [http://tortoisesvn.tigris.org/ Tortoise SVN] (recommended). The commit message should state that this corresponds to this release.

= Updating the web site =

Check out and/or SVN update the erights.org website. The following assumes that the "doc" directory is placed under "e" as a sibling to "src".

<code>$ cd ../doc/dowload
$ ls -la</code>

We see an "0-9-1" directory but no "0-9-2" directory. We copy 0-9-1 to make an initial draft 0-9-2, remove all 0-9-2 ".svn" subdirectories, and modify 0-9-2 to reflect the new release.

<code>$ cp -r 0-9-1 0-9-2
$ cd 0-9-2
$ rm -rf `find . -name '.svn'`</code>

Note that this directory copy-and-revise is not a good practice. We should switch towards documenting the current release on wiki.erights.org, and maintain a single canonical set of install documentation, rather than a per-release copy.

Within the 0-9-2 directory,
* Replace all occurrences of "0.9.1b" with "0.9.2a".
* Replace all "0-9-1" with "0-9-2". This will inappropriately change some of the navigation button links at the top and bottom of the page, but we will repair those below.
* Because I have stupidly temporarily lost access to my account on cypherpunks.to, I am replacing all "https://www.cypherpunks.to/erights/download/0-9-2/" with nothing, turning the rest of these links into links into the local directory.
(The tool I happen to use for search-and-replace is also my favorite almost-wysiwyg html editor, Dreamweaver.)

Then, back up in the doc directory (the root of the website)

<code>$ cd ../..</code>

I edit toc.txt to include the new 0-9-2 copy of the files. Save. Then rebuild the page navigation buttons

<code>$ make buttons</code>

Next, I revise the text on the pages in this directory to more accurately describe the 0.9.2a release. Kevin reminds me that these pages have carried forward many old issues, like daffE, which are no longer relevant. Since this leads to the removal of several files (README.html, highlights.html, linux-motif-x86-install.html, linux-gtk-x86-install.html, and mac-ppc-install.html), I also remove any that appear in the 0-9-2 section of toc.txt and re "make buttons" as above.

I do an SVN commit of all relevant files.

== Uploading and Finishing Touches ==

Then I build the doc.tar.gz representing the surface of the new erights.org website. I use the following private bash function (in my "~/.bashrc" which is not checked in because it hasn't yet been engineered for use by anyone else:

<code>mkdoc ()
{
rm -rf ~/efoo/doc;
echo "starting";
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .html;
echo "html";
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .gif;
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .jpg;
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .jpeg;
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .png;
rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .txt;
echo "copied";
rm -rf `find ~/efoo/doc -name .svn`;
rm -rf ~/efoo/doc/talks/e-overview;
rm -rf ~/efoo/doc/javadoc;
echo "prepared";
( cd ~/efoo;
tar czf ~/e/doc/download/doc.tar.gz doc );
echo "packaged";
( cd ~/e/doc/download;
scp doc.tar.gz combexin@combex.com:e/doc/download );
( cd ~/e/doc/download;
scp doc.tar.gz markm@www.cypherpunks.to:e/doc/download )
}</code>

Because I don't currently have access to my cypherpunks.to account, the last scp above will fail.

Once the scp'ing is done, I then manually ssh into each of these sites (currently just combex.com) and do

<code># Remotely at the combex.com site
$ cd ~/e
$ tar xzf doc/download/doc.tar.gz</code>

Yes, I know that I can do this directly with ssh commands, but whether out of habit or a false need for hand-on comfort, I don't.

With the new website in place, I finally transfer the E distribution tarballs there. I do so by first copying them into my local 0-9-2 directory, so that my local directory will more faithfully reflect the real site.

<code># Locally again in my 0-9-2 directory
$ cp ../../../tarballs/*.zip ../../../tarballs/*.gz .
$ scp *.zip *.gz combexin@combex.com:e/doc/download/0-9-2</code>

I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. Oops. I notice that I forgot to edit the [http://erights.org/download/index.html download page] to point at the 0-9-2 directory. Go through the edit, SVN commit, mkdoc, scp, ssh, unpack, check cycle again.

And finally I [http://www.eros-os.org/pipermail/e-lang/2009-May/013126.html announce on e-lang].

Markm: /* Updating the web site */

2009-05-13T01:30:26Z

Updating the web site

←Older revision		Revision as of 01:30, 13 May 2009
Line 91:		Line 91:

	I do an SVN commit of all relevant files.		I do an SVN commit of all relevant files.
		+
		+	== Uploading and Finishing Touches ==

	Then I build the doc.tar.gz representing the surface of the new erights.org website. I use the following private bash function (in my "~/.bashrc" which is not checked in because it hasn't yet been engineered for use by anyone else:		Then I build the doc.tar.gz representing the surface of the new erights.org website. I use the following private bash function (in my "~/.bashrc" which is not checked in because it hasn't yet been engineered for use by anyone else:
Line 135:		Line 137:
	$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>		$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>

-	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. Oops. I notice that I forgot to edit the [http://erights.org/download/index.html download page] to point at the 0-9-2 directory. Go through the edit, SVN commit, mkdoc, scp, unpack, check cycle again.	+	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. Oops. I notice that I forgot to edit the [http://erights.org/download/index.html download page] to point at the 0-9-2 directory. Go through the edit, SVN commit, mkdoc, scp, ssh, unpack, check cycle again.

	And finally I announce on e-lang.		And finally I announce on e-lang.

Markm: /* Updating the web site */

2009-05-13T01:19:56Z

Updating the web site

←Older revision		Revision as of 01:19, 13 May 2009
Line 135:		Line 135:
	$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>		$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>

-	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.	+	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. Oops. I notice that I forgot to edit the [http://erights.org/download/index.html download page] to point at the 0-9-2 directory. Go through the edit, SVN commit, mkdoc, scp, unpack, check cycle again.
		+
		+	And finally I announce on e-lang.

Markm: /* not yet done below this line */

2009-05-12T23:47:16Z

not yet done below this line

←Older revision		Revision as of 23:47, 12 May 2009
Line 120:		Line 120:

	Because I don't currently have access to my cypherpunks.to account, the last scp above will fail.		Because I don't currently have access to my cypherpunks.to account, the last scp above will fail.
-
-	~~== not yet done below this line ==~~

	Once the scp'ing is done, I then manually ssh into each of these sites (currently just combex.com) and do		Once the scp'ing is done, I then manually ssh into each of these sites (currently just combex.com) and do
Line 127:		Line 125:
	<code># Remotely at the combex.com site		<code># Remotely at the combex.com site
	$ cd ~/e		$ cd ~/e
-	$ tar xzf download/doc.tar.gz	+	$ tar xzf doc/download/doc.tar.gz</code>

	Yes, I know that I can do this directly with ssh commands, but whether out of habit or a false need for hand-on comfort, I don't.		Yes, I know that I can do this directly with ssh commands, but whether out of habit or a false need for hand-on comfort, I don't.
Line 133:		Line 131:
	With the new website in place, I finally transfer the E distribution tarballs there. I do so by first copying them into my local 0-9-2 directory, so that my local directory will more faithfully reflect the real site.		With the new website in place, I finally transfer the E distribution tarballs there. I do so by first copying them into my local 0-9-2 directory, so that my local directory will more faithfully reflect the real site.

-	<code># Locally again in ~~the~~ 0-9-2 directory	+	<code># Locally again in my 0-9-2 directory
	$ cp ../../../tarballs/.zip ../../../tarballs/.gz .		$ cp ../../../tarballs/.zip ../../../tarballs/.gz .
	$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>		$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>

	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.		I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.

Markm: /* not yet done below this line */

2009-05-12T23:27:04Z

not yet done below this line

←Older revision		Revision as of 23:27, 12 May 2009
Line 134:		Line 134:

	<code># Locally again in the 0-9-2 directory		<code># Locally again in the 0-9-2 directory
-	$ cp ../../../tarballs/.zip .gz .	+	$ cp ../../../tarballs/.zip ../../../tarballs/.gz .
	$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>		$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>

	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.		I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.

Markm: /* Updating the web site */

2009-05-12T23:25:28Z

Updating the web site

←Older revision		Revision as of 23:25, 12 May 2009
Line 88:		Line 88:
	<code>$ make buttons</code>		<code>$ make buttons</code>

-	Next, I revise the text on the pages in this directory to more accurately describe the 0.9.2a release. Kevin reminds me that these pages have carried forward many old issues, like daffE, which are no longer relevant.	+	Next, I revise the text on the pages in this directory to more accurately describe the 0.9.2a release. Kevin reminds me that these pages have carried forward many old issues, like daffE, which are no longer relevant. Since this leads to the removal of several files (README.html, highlights.html, linux-motif-x86-install.html, linux-gtk-x86-install.html, and mac-ppc-install.html), I also remove any that appear in the 0-9-2 section of toc.txt and re "make buttons" as above.

-	~~More soon..~~.	+	I do an SVN commit of all relevant files.

-	<code>$ cp ../../../tarballs/.zip .gz .	+	Then I build the doc.tar.gz representing the surface of the new erights.org website. I use the following private bash function (in my "~/.bashrc" which is not checked in because it hasn't yet been engineered for use by anyone else:
		+
		+	<code>mkdoc ()
		+	{
		+	rm -rf ~/efoo/doc;
		+	echo "starting";
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .html;
		+	echo "html";
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .gif;
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .jpg;
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .jpeg;
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .png;
		+	rune ~/e/src/esrc/scripts/copyOnly.e '~/'e/doc '~/'efoo/doc .txt;
		+	echo "copied";
		+	rm -rf `find ~/efoo/doc -name .svn`;
		+	rm -rf ~/efoo/doc/talks/e-overview;
		+	rm -rf ~/efoo/doc/javadoc;
		+	echo "prepared";
		+	( cd ~/efoo;
		+	tar czf ~/e/doc/download/doc.tar.gz doc );
		+	echo "packaged";
		+	( cd ~/e/doc/download;
		+	scp doc.tar.gz combexin@combex.com:e/doc/download );
		+	( cd ~/e/doc/download;
		+	scp doc.tar.gz markm@www.cypherpunks.to:e/doc/download )
		+	}</code>
		+
		+	Because I don't currently have access to my cypherpunks.to account, the last scp above will fail.
		+
		+	== not yet done below this line ==
		+
		+	Once the scp'ing is done, I then manually ssh into each of these sites (currently just combex.com) and do
		+
		+	<code># Remotely at the combex.com site
		+	$ cd ~/e
		+	$ tar xzf download/doc.tar.gz
		+
		+	Yes, I know that I can do this directly with ssh commands, but whether out of habit or a false need for hand-on comfort, I don't.
		+
		+	With the new website in place, I finally transfer the E distribution tarballs there. I do so by first copying them into my local 0-9-2 directory, so that my local directory will more faithfully reflect the real site.
		+
		+	<code># Locally again in the 0-9-2 directory
		+	$ cp ../../../tarballs/.zip .gz .
	$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>		$ scp .zip .gz combexin@combex.com:e/doc/download/0-9-2</code>
		+
		+	I use my browser to check that the website looks good and that the download links work. I update [[ReleaseNotes092]] to point at [http://erights.org/download/0-9-2/]. I update [[Downloads]]. And I announce on e-lang.

Markm at 22:44, 12 May 2009

2009-05-12T22:44:37Z

←Older revision		Revision as of 22:44, 12 May 2009
Line 1:		Line 1:
-	I am seeding this page by jotting down notes on the process of performing the [ReleaseNotes092 E 0.9.2 release], as a guide to others who may do future releases or more fully automate the process (please!). This information is descriptive; not prescriptive.	+	I am seeding this page by jotting down notes on the process of performing the [[ReleaseNotes092\|E 0.9.2 release]], as a guide to others who may do future releases or more fully automate the process (please!). This information is descriptive; not prescriptive.

	At Kevin's suggestion, I did a		At Kevin's suggestion, I did a

Markm: /* Updating the web site */

2009-05-12T22:12:46Z

Updating the web site

←Older revision		Revision as of 22:12, 12 May 2009
Line 71:		Line 71:
	$ cd 0-9-2		$ cd 0-9-2
	$ rm -rf `find . -name '.svn'`</code>		$ rm -rf `find . -name '.svn'`</code>
		+
		+	Note that this directory copy-and-revise is not a good practice. We should switch towards documenting the current release on wiki.erights.org, and maintain a single canonical set of install documentation, rather than a per-release copy.

	Within the 0-9-2 directory,		Within the 0-9-2 directory,
Line 86:		Line 88:
	<code>$ make buttons</code>		<code>$ make buttons</code>

-		+	Next, I revise the text on the pages in this directory to more accurately describe the 0.9.2a release. Kevin reminds me that these pages have carried forward many old issues, like daffE, which are no longer relevant.

	More soon...		More soon...

Markm at 22:08, 12 May 2009

2009-05-12T22:08:18Z

←Older revision		Revision as of 22:08, 12 May 2009
Line 1:		Line 1:
-	I am seeding this page by jotting down notes on the process of performing the [ReleaseNotes092 E 0.9.2 release], as a guide to others who may do future releases. This information is descriptive; not prescriptive.	+	I am seeding this page by jotting down notes on the process of performing the [ReleaseNotes092 E 0.9.2 release], as a guide to others who may do future releases or more fully automate the process (please!). This information is descriptive; not prescriptive.

	At Kevin's suggestion, I did a		At Kevin's suggestion, I did a

Markm: /* Updating the web site */

2009-05-12T22:07:29Z

Updating the web site

←Older revision		Revision as of 22:07, 12 May 2009
Line 71:		Line 71:
	$ cd 0-9-2		$ cd 0-9-2
	$ rm -rf `find . -name '.svn'`</code>		$ rm -rf `find . -name '.svn'`</code>
		+
		+	Within the 0-9-2 directory,
		+	* Replace all occurrences of "0.9.1b" with "0.9.2a".
		+	* Replace all "0-9-1" with "0-9-2". This will inappropriately change some of the navigation button links at the top and bottom of the page, but we will repair those below.
		+	* Because I have stupidly temporarily lost access to my account on cypherpunks.to, I am replacing all "https://www.cypherpunks.to/erights/download/0-9-2/" with nothing, turning the rest of these links into links into the local directory.
		+	(The tool I happen to use for search-and-replace is also my favorite almost-wysiwyg html editor, Dreamweaver.)
		+
		+	Then, back up in the doc directory (the root of the website)
		+
		+	<code>$ cd ../..</code>
		+
		+	I edit toc.txt to include the new 0-9-2 copy of the files. Save. Then rebuild the page navigation buttons
		+
		+	<code>$ make buttons</code>
		+
		+

	More soon...		More soon...