Class Horde_Release

Description

Class to make an "official" Horde or application release.

$Horde: framework/Horde/Horde/Release.php,v 1.27.2.13 2010/04/28 21:10:16 jan Exp $

Copyright 1999 Mike Hardy Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Horde/Horde/Release.php (line 17)


	
			
Variable Summary
Method Summary
 Horde_Release Horde_Release ([ $options = array()])
 void addWhupsVersion ()
 void announce ([ $doc_dir = null])
 void checkArguments ()
 void checkOutFramework ( $mod_version,  $directory)
 void checkOutTag ( $mod_version,  $directory, [ $module = null])
 void checkSetSystem ()
 void cleanDirectories ( $directory)
 void deleteDirectory ( $directory)
 void diff ()
 void getArguments ()
 void makeTarball ()
 void print_usage ([ $message = null])
 void saveChangelog ([ $old = false], [ $directory = null])
 void tagSource ([ $directory = null], [ $version = null])
 void test ()
 void updateSentinel ()
 void updateVersionFile ( $directory,  $version_string)
 void upload ()
 void _fmVerify ( $fm)
Variables
array $binaryDiffs = array() (line 153)

The list of binary diffs.

string $changelogVersion (line 94)

Revision number of CHANGES file.

string $directoryName (line 118)

Directory name of unpacked tarball.

string $hordeVersionString (line 66)

Major version number of Horde compatible to this release.

boolean $latest = true (line 181)

Whether or not this is a final release version.

boolean $makeDiff = false (line 146)

Whether or not to create a patch file.

string $newSourceVersionString (line 52)

Version number of next release.

string $newSourceVersionStringPlain (line 59)

Version number of next release for docs/CHANGES.

string $oldChangelogVersion (line 101)

Revision number of previous CHANGES file.

string $oldDirectoryName (line 125)

Directory name of unpacked previous tarball.

string $oldHordeVersionString (line 73)

Major version number of Horde compatible to the previous release.

string $oldSourceVersionString (line 45)

Version number of previous release.

string $oldTagVersionString (line 87)

CVS tag of previous release.

boolean $oldVersion = false (line 160)

Whether or not we have an old version to compare against.

array $options = array(
'test' => false,
'nocommit' => false,
'noftp' => false,
'noannounce' => false,
'nofreshmeat' => false,
'nowhups' => false,
)
(line 24)

Default options.

string $patchMD5 (line 174)

MD5 sum of the patch file.

string $patchName (line 167)

Filename of the gzip'ed patch file (without .gz extension).

string $sourceVersionString (line 38)

Version number of release.

string $tagVersionString (line 80)

CVS tag of release.

string $tarballMD5 (line 139)

MD5 sum of the tarball.

string $tarballName (line 132)

Filename of the tarball.

mixed $ticketVersion (line 106)

Version string to use in Whups

mixed $ticketVersionDesc = '' (line 111)

Version description to use in Whups

Methods
Constructor Horde_Release (line 186)

Load the configuration

Horde_Release Horde_Release ([ $options = array()])
  • $options
addWhupsVersion (line 706)

Add the new version to bugs.horde.org

void addWhupsVersion ()
announce (line 515)

announce release to mailing lists and freshmeat.

void announce ([ $doc_dir = null])
  • $doc_dir
checkArguments (line 960)

Check the command-line arguments and set some internal defaults

void checkArguments ()
checkOutFramework (line 426)

Checkout and install framework

void checkOutFramework ( $mod_version,  $directory)
  • $mod_version
  • $directory
checkOutTag (line 391)

Check out the tag we've been given to work with and move it to the

directory name given

void checkOutTag ( $mod_version,  $directory, [ $module = null])
  • $mod_version
  • $directory
  • $module
checkSetSystem (line 1002)

Check the command-line arguments and set some internal defaults

void checkSetSystem ()
cleanDirectories (line 372)

work through the source directory given, cleaning things up by removing

directories and files we don't want in the tarball

void cleanDirectories ( $directory)
  • $directory
deleteDirectory (line 203)

Delete the directory given as an argument

void deleteDirectory ( $directory)
  • $directory
diff (line 248)

Make a diff of the two directories given as arguments

void diff ()
getArguments (line 883)

Get all of the command-line arguments from the user

void getArguments ()
makeTarball (line 212)

tar and gzip the directory given as an argument

void makeTarball ()
print_usage (line 1011)

Show people how to use the damned thing

void print_usage ([ $message = null])
  • $message
saveChangelog (line 340)

get and save the revision number of the CHANGES file

void saveChangelog ([ $old = false], [ $directory = null])
  • $old
  • $directory
setVersionStrings (line 751)

Set the version strings to use given the arguments

void setVersionStrings ()
tagSource (line 229)

Label all of the source here with the new label given as an argument

void tagSource ([ $directory = null], [ $version = null])
  • $directory
  • $version
test (line 664)

Do testing (development only)

void test ()
updateSentinel (line 308)

Update the CHANGES file with the new version number

void updateSentinel ()
updateVersionFile (line 276)

Change the version file for the module in the directory specified to

the version specified

void updateVersionFile ( $directory,  $version_string)
  • $directory
  • $version_string
upload (line 465)

Upload tarball to the FTP server

void upload ()
_fmVerify (line 500)

check if freshmeat announcement was successful.

void _fmVerify ( $fm)
  • $fm

Documentation generated on Sun, 30 Jan 2011 05:20:50 +0000 by phpDocumentor 1.4.3