Java CoG Kit Guide to the Java CoG Kit Release Process for Developers

Gregor von Laszewski

Software Version: 4_1_2
Manual version: 02/18/05
Url: http://www.cogkit.org/release/4_1_2/manual/release-dev.pdf
Url: http://www.cogkit.org/release/4_1_2/manual/release-dev/release-dev.html
Last update: July 11, 2005

Contents

1 About this Document
 1.1 Reproduction
 1.2 Viewing
 1.3 Format
2 Registration
3 Introduction
4 Decide for a release
5 Code Freeze
6 Naming the Version
7 Tagging the CVS archive
8 Generate a release bundle
9 Update the Wiki
10 Generate the Web pages
 10.1 Set the current directory
11 Generate the Documentation
 11.1 Checkout
 11.2 Compile and Publish
12 Update
13 Selective update
 13.1 Announcements
 13.2 Anouncement Opportunities
  13.2.1 freshmeat
14 Release tags: jglobus
Appendix
A Java CoG Kit Guides
B Java CoG Kit Guides Under Construction
C Available Downloads
D Availability of the Document
E Bugs
F Administrative Contact

 

1 About this Document

This document includes basic information about the Java CoG Kit release process.

1.1 Reproduction

The material presented in this document can not be published, mirrored, electronically or otherwise reproduced without prior written consent. As you can link to this document, this should not pose much of a restriction.

1.2 Viewing

The best way to read this document is with Adobe Acrobat Reader. Please make sure you configure Adobe Acrobat Reader appropriately so you can follow hyperlinks. This is the case if you follow the default installation. Acrobat Reader is available at http://www.adobe.com/products/acrobat/readermain.html. Because the hyperlinks are not available in the printed form of this manual and we support saving our environment we strongly discourage printing this document.

We recommend that you save this manual locally on your machine and use Acrobat Reader. This has the advantage that you do not lose your anchor points while switching back and forth between different hyperlinks. An HTML version of this manual is planed, but not available yet.

1.3 Format

We have augmented the document with some comments at places where we found issues. Our intend is to address these issues in a future release. The comments are marked by the icon  to do  and the name of the person that will work on the removal of the issue.

2 Registration

Please be a team player and support us indirectly by registering with us or reporting your use of the Java CoG Kit. Although this software is free, we still need to justify to our funders the usefulness of the projects. If you want to help us with our efforts please take a few seconds to complete this information. We do not use this information for other purposes. If you have special needs or concerns please contact gregor@mcs.anl.gov. The registration form can filled out in a variety of formats. The online form can be found at

http://www.cogkit.org/register

This form is available also as ASCII text at

http://www.cogkit.org/register/form.txt

which you can FAX to

Gregor von Laszewski, Fax: 630 252 1997

3 Introduction

As we are an open source project, we like to present you with some information about our release process. This is important as we like you to contribute to our efforts and help us streamlining the process and be part of it.

  1. decide that a release is necessary
  2. freeze the code, documentation, and Web development
  3. decide for a relase version
  4. derive a release tag for the CVS for the release version.
  5. tag the CVS with a RC version
  6. do a release candidate of the release and verify that the dryrun of the release works. This is done in a preliminary non public release space.

    1. generate the new bundles
    2. generate the new web page
    3. generate the new documentation
    4. test the release candidate
    5. goto Step 4 in case of failure
  7. tag the CVS archives
  8. publish the new code
  9. publish the documentation
  10. update the Web page
  11. test the release
  12. make announcements

4 Decide for a release

We will make a joint decission in the Java CoG Kit team when a release is necessary. Usually, we expect one major release per year, but in case major upgrades are done we will make additional releases available. Additionally, we like to allign our release wit the Globus Toolkit releases. However, in the past these releases have been irregular. Once a toolkit is release we attempt our best to produce a Java CoG Kit release within two month.

Even numbers at the end are considered to be production releases. Uneven numbers are considered development versions.

In the year 2005 we are currently planing the following releases:

Mar: Java CoG Kit version 4.0.a
Apr: Java CoG Kit version 4.0.rc1
Apr: Java CoG Kit version 4.0
June: Java CoG Kit version 4.1
Sep: Java CoG Kit version 4.2.rc1
Sep: Java CoG Kit version 4.2

More information about the release plans are formulated within our development wiki http://www.cogkit.org/wiki/cog/moin.cgi/CoGKit/Plan

5 Code Freeze

Before a releas tag is assigned to the CVS a development freeze is announced to the development list at

gridnauts@globus.org and developers@cogkit.org

6 Naming the Version

The Java CoG Kit version number follows currently the following pattern. We distinguish major, minor, and tiny release numbers. Major release numbers are done when major changes occur. This usually happens when a new version of for example the Globus Toolkit is announced and we have to port to it. Minor numbers are internal numbers. Tiny numbers are simple fixes.

<major>.<minor>.<tiny>  
<major>:= [4-9][0-9]*  
<minor>:= [0-9]+  
<tiny>:= [a-d]*[1-9][0-9]*

These numbers are also tags within the CVS and can be used to download the code.

cog-<major>_<minor>_<tiny>

However not every tag will be distributed as packages. Only those with an even minor number will be released as bundles. All other versions must be retrieved from CVS at this time.

7 Tagging the CVS archive

As we have a number of CVS modules we need to carefully tag them. This should only be done by Gregor and Mike and should be coordinated with them. Below we give the example on how to tag the release for the version 4_1_2.

USER=‘whoami‘  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION www  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION doc  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION src/cog  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION src/tools  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION src/jglobus-fx  
cvs -d$USER@cvs.cogkit.org:/cvs/cogkit rtag cog\_\COGVERSION src/matlab  
cvs -d$USER@wiggum.mcs.anl.gov:/home/dsl/cog/CVS rtag cog\_\COGVERSION jglobus

8 Generate a release bundle

_________________________________________________________________________________________
 to do 

Mike: TBD
___________________________________________________________________________________________________________________________________

9 Update the Wiki

We need to update our Wiki to reflect the new release. The following pages on the Wiki need to be modified:

10 Generate the Web pages

_____________________________________________________________________________________________________________________________________________
 to do 

Gregor: need to spend more time on cleaning the web pages.
___________________________________________________________________________________________________________________________________

 to do 

Gregor: we may have a significant number of outdated pages on globus.org that need to be revisited.
_________________________________________________________________________________________

The Java CoG Kit Web pages can be checked out as follows where where cog_4_1_2is the release tag _____________________________________________________________________________________________________________________________________________

 to do 

Gregor: I have not made sure if all updates are in the CVS yet. Have some pages been modified directly such as the php scripts?
___________________________________________________________________________________________________________________________________

  1. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit login
  2. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit checkout -r cog_4_1_2www/www-cogkit-org
  3. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit checkout -r cog_4_1_2www/www-cogkits-org
  4. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit checkout -r cog_4_1_2www/www-globus-org-cog

www-cogkit-org
This Web page contains the main cogkit web page at http://www.cogkit.org. However we maintain the current contents mostly in the Wiki at http://www.cogkits.org/wiki
www-cogkits-org
http://www.cogkits.org is just a forward link to http://www.cogkits.org
www-globus-org-cog
This is the very first CoG Kit web page which points mostly to http://www.cogkit.org

Most updates should be made on the Wiki. You can apply for accounts on the Wiki with gregor@mcs.anl.gov. _____________________________________________________________________________________________________________________________________________

 to do 

Gregor: write about make publish
___________________________________________________________________________________________________________________________________

10.1 Set the current directory

log into the cvs.cogkit.org/www/www.cogkit.org set

rm current

ln -s release/4_1_2current

11 Generate the Documentation

The Java CoG Kit guides can be easily generated form scratch by using the following commands:

11.1 Checkout

First check out the documentation


1  #! /bin/bash
2  TAG=cog_‘head -1 ../VERSION.txt‘
3  CVS=‘whoami‘@cvs.cogkit.org:/cvs/cogkit
4  mkdir cogkit
5  cd cogkit
6  cvs -d:pserver:$CVS login
7  cvs -d:pserver:$CVS checkout -r $TAG manual/guide
8  cvs -d:pserver:$CVS checkout -r $TAG papers/bib

11.2 Compile and Publish

Now you can compile the code. We assume you have changed to the cogkit directory and have checked out the code correctly


1  cd manual/guide
2  make clean
3  make release
4  make publish

12 Update


1  cd manual/guide
2  emacs VERSION.txt # change appropiatly
3  make local

inspect changes.

13 Selective update


1  cd <guide dir>
2  make local
3  inspect by browsing guide.pdf
4  cd ..
5  see Section Compile and Publish

13.1 Announcements

The CoG Kit team is happy to announce a new version of the Java CoG Kit. The version is 4_1_2. More information about this version can be found at

http://www.cogkit.org/release/4_1_2

Some of the features included in this release are:

This release was tested with Java version 1.4.2.

13.2 Anouncement Opportunities

13.2.1 freshmeat

The information for freshmeat is as follows:

Generic project information  
 
Section to submit to:  
Unix [x]  
 
Full project name:  
Java CoG Kit  
 
 
Short project name:  
cogkit  
 
 
Full description:  
The Java CoG Kit is provides convenient access to Grid  
middleware through the Java framework. It contains a Grid  
workflow programming paradigm, Grid middleware abstractions,  
a Grid shell, and graphical components. It can be used to  
build grid portals.  
 
It is most useful for Grid users that focus on file transfer, job  
submission, and authentication.  
 
Short description:  
Simple access to Grid workflows and middleware through Java  
 
 
 
Name of author: Gregor von Laszewski & CoG Team  
 
 
Email address:  
gregor@mcs.anl.gov  
 
Default branch information  
 
Branch name:  
Branch description:  
 
License:  
BSD License (Revised)  
 
Homepage:  
http://www.cogkit.org  
 
Tar/GZ:  
Tar/BZ2:  
Zip:  
 
Changelog:  
http://www.cogkit.org/viewcvs/viewcvs.cgi/src/cog/CHANGES.txt?rev=HEAD&content-type=text/vnd.viewcvs-markup  
 
RPM package:  
Debian package:  
OS X package:  
BSD Ports URL:  
 
Purchase:  
free  
 
CVS tree (cvsweb):  
http://www.cogkit.org/viewcvs/viewcvs.cgi/src/cog/  
 
Bug tracker:  
http://www-unix.globus.org/cog/contact/bugs/  
 
Mailing list archive:  
http://www-unix.globus.org/mail_archive/java/maillist.html  
 
Mirror site:  
 
Demo site:  
http://www.cogkit.org  
 
Version:  
4.0.a1  
 
Release focus: 1  
 
Changes:  
* workflow improvements  
* Grid midleware providers for GT2 and GT3  
 
Hide from frontpage: no  

source forge

java@globus.org

discuss@globus.org

in case gt4

gt4-freinds@globus.org

1 _________________________________________________________________________________________

 to do 

Gregor: STEP2 is missing
_________________________________________________________________________________________

14 Release tags: jglobus

The 1.2 release was tagged with ”cog-1_2” tag. The code in jglobus-jgss branch was tagged with ”globus_3_9_5” (at the same time as rest of GT). The code in trunk (HEAD) has no tag. It will be tagged when we actually have a new GT release or jglobus release (if on different date).

The head is curently tagged with cog_4_0_a1.

References

[1]   G. von Laszewski, I. Foster, J. Gawor, and P. Lane, “A Java Commodity Grid Kit,” Concurrency and Computation: Practice and Experience, vol. 13, no. 8-9, pp. 643–662, 2001. [Online]. Available: http://www.mcs.anl.gov/~gregor/papers/vonLaszewski--cog-cpe-final.pdf

[2]   “Java CoG Kit Wiki,” 2004. [Online]. Available: http://www.cogkit.org/wiki

[3]   “Java CoG Kit Registration,” 2004. [Online]. Available: http://www.cogkit.org/register

Additional publications about the Java CoG Kit can be found as part of the vita of Gregor von Laszewski http://www-unix.mcs.anl.gov/~laszewsk/vita.pdf. Most documents are avalable online if you follow the links. In future we intend to provide this information without Gregors vita data.

If you need to cite the Java CoG Kit, please use [1].

Appendix

A Java CoG Kit Guides




Short Title Description Format



Guide A guide to help you finding out what guides have been written[PDF] [HTML]



Install A guide to the different ways of installing the Java CoG Kit [PDF] [HTML]



Commands A guide to the command line tools of the Java CoG Kit [PDF] [HTML]



Workflow A guide to the Gridant/Karajan Workflow [PDF] [HTML]



AbstractionsA guide to the Java CoG Kit abstractions API [PDF] [HTML]



JavaDoc The Java API documentation to the Java CoG Kit [HTML]



Coding A guide to the Coding rules for the Java CoG Kit [PDF] [HTML]



Overview A future guide that will be an overview to the Java CoG Kit [PDF] [HTML]



B Java CoG Kit Guides Under Construction

More guides are under development. The following guides are not yet completed, but are listed here to help us improving these guides. Please, explore them and send us e-mail about improvement suggestions. If you like to contribute a guide yourself, please contact gregor@mcs.anl.gov.




Short Title Description Format



MPI A preliminary guide to execute MPI programs on the TeraGrid and alike[PDF] [HTML]



Release ProcessA preliminary guide to document the release process [PDF] [HTML]



Guide A preliminary guide to document writing guides [PDF] [HTML]



Examples A preliminary guide to examples alike [PDF] [HTML]



C Available Downloads

First time users of the Java CoG Kit should read the “Guide to Installing the Java CoG Kit” [PDF] [HTML]. We hope that you will find this guide useful to decide which bundles you need. For the more experienced user, we provide the following table.

Binary Distributions
 
Source Distributions
 
API Documentation
 
Module List
 
CVS
 

D Availability of the Document

The newest version of this document can be downloaded by the developers from

  1. cvs -d:pserver:anonymous@cvs.cogkit.org:/cvs/cogkit checkout manual/guide

It is not allowed to reproduce this document or the source. This documentation is copyrighted and is not distributed under the CoG Kit license.

E Bugs

This guide is constantly improved and your input is highly appreciated. Please report suggestion, errors, changes, and new sections or chapters through our Bugzilla system at

http://www-unix.globus.org/cog/contact/bugs/

F Administrative Contact

The Java CoG Kit project has been initiated and is managed by Gregor von Laszewski. To contact him, please use the information below.

Gregor von Laszewski
Argonne National Laboratory
Mathematics and Computer Science Division
9700 South Cass Avenue
Argonne, IL 60439
Phone:(630) 252 0472
Fax: (630) 252 1997
gregor@mcs.anl.gov

Index

0 TASKS
    To do
        Gregor, 5, 9
        Mike, 4

Administrative Contact, 11

Contact, 11

Registration, 2