\Horde_Release

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

Summary

Methods

Properties

Constants

__construct()
__get()
deleteDirectory()
makeTarball()
tagSource()
diff()
updateVersionFile()
updateSentinel()
saveChangelog()
cleanDirectories()
checkOutTag()
checkOutFramework()
upload()
announce()
test()
addWhupsVersion()
setVersionStrings()
getArguments()
checkArguments()
checkSetSystem()
print_usage()

$notes

No constants found

No protected methods found

$_options
$_sourceVersionString
$_oldSourceVersionString
$_newSourceVersionString
$_newSourceVersionStringPlain
$_hordeVersionString
$_oldHordeVersionString
$_tagVersionString
$_oldTagVersionString
$_changelogVersion
$_oldChangelogVersion
$_ticketVersion
$_ticketVersionDesc
$_directoryName
$_oldDirectoryName
$_tarballName
$_tarballMD5
$_makeDiff
$_binaryDiffs
$_oldVersion
$_patchName
$_patchMD5
$_latest

N/A

No private methods found

No private properties found

N/A

File: Release.php
Package: Release
Class hierarchy: \Horde_Release
See also: http://www.horde.org/libraries/Horde_Release

$_options

$_options : array

Default options.

Type

array

$_sourceVersionString

$_sourceVersionString : string

Version number of release.

Type

string

$_oldSourceVersionString

$_oldSourceVersionString : string

Version number of previous release.

Type

string

$_newSourceVersionString

$_newSourceVersionString : string

Version number of next release.

Type

string

$_newSourceVersionStringPlain

$_newSourceVersionStringPlain : string

Version number of next release for doc/CHANGES.

Type

string

$_hordeVersionString

$_hordeVersionString : string

Major version number of Horde compatible to this release.

Type

string

$_oldHordeVersionString

$_oldHordeVersionString : string

Major version number of Horde compatible to the previous release.

Type

string

$_tagVersionString

$_tagVersionString : string

CVS tag of release.

Type

string

$_oldTagVersionString

$_oldTagVersionString : string

CVS tag of previous release.

Type

string

$_changelogVersion

$_changelogVersion : string

Revision number of CHANGES file.

Type

string

$_oldChangelogVersion

$_oldChangelogVersion : string

Revision number of previous CHANGES file.

Type

string

$_ticketVersion

$_ticketVersion : string

Version string to use in Whups

Type

string

$_ticketVersionDesc

$_ticketVersionDesc : string

Version description to use in Whups

Type

string

$_directoryName

$_directoryName : string

Directory name of unpacked tarball.

Type

string

$_oldDirectoryName

$_oldDirectoryName : string

Directory name of unpacked previous tarball.

Type

string

$_tarballName

$_tarballName : string

Filename of the tarball.

Type

string

$_tarballMD5

$_tarballMD5 : string

MD5 sum of the tarball.

Type

string

$_makeDiff

$_makeDiff : boolean

Whether or not to create a patch file.

Type

boolean

$_binaryDiffs

$_binaryDiffs : array

The list of binary diffs.

Type

array

$_oldVersion

$_oldVersion : boolean

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

Type

boolean

$_patchName

$_patchName : string

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

Type

string

$_patchMD5

$_patchMD5 : string

MD5 sum of the patch file.

Type

string

$_latest

$_latest : boolean

Whether or not this is a final release version.

Type

boolean

Methods

__construct()

__construct(  $options = array())

Load the configuration

Parameters

$options

__get()

__get(  $property)

Parameters

$property

deleteDirectory()

deleteDirectory(  $directory)

Delete the directory given as an argument

Parameters

$directory

makeTarball()

makeTarball()

tar and gzip the directory given as an argument

tagSource()

tagSource(  $directory = null,   $version = null)

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

Parameters

	$directory
	$version

diff()

diff()

Make a diff of the two directories given as arguments

updateVersionFile()

updateVersionFile(  $directory,   $version_string)

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

Parameters

	$directory
	$version_string

updateSentinel()

updateSentinel()

Update the CHANGES file with the new version number

saveChangelog()

saveChangelog(  $old = false,   $directory = null)

get and save the revision number of the CHANGES file

Parameters

	$old
	$directory

cleanDirectories()

cleanDirectories(  $directory)

work through the source directory given, cleaning things up by removing directories and files we don't want in the tarball

Parameters

$directory

checkOutTag()

checkOutTag(  $mod_version,   $directory,   $module = null)

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

Parameters

	$mod_version
	$directory
	$module

checkOutFramework()

checkOutFramework(  $mod_version,   $directory)

Checkout and install framework

Parameters

	$mod_version
	$directory

upload()

upload()

Upload tarball to the FTP server

announce()

announce(  $doc_dir = null)

announce release to mailing lists.

Parameters

$doc_dir

test()

test()

Do testing (development only)

addWhupsVersion()

addWhupsVersion()

Add the new version to bugs.horde.org

setVersionStrings()

setVersionStrings()

Set the version strings to use given the arguments

getArguments()

getArguments()

Get all of the command-line arguments from the user

checkArguments()

checkArguments()

Check the command-line arguments and set some internal defaults

checkSetSystem()

checkSetSystem()

Check the command-line arguments and set some internal defaults

print_usage()

print_usage(  $message = null)

Show people how to use the damned thing

Parameters

$message