PHP Class Horde_Release, horde

Author: Mike Hardy
Author: Jan Schneider ([email protected])
Mostra file Open project: horde/horde

Public Properties

Property Type Description
$notes array May be refactored to use a setter for each property the release notes sets...

Protected Properties

Property Type Description
$_binaryDiffs array The list of binary diffs.
$_changelogVersion string Revision number of CHANGES file.
$_directoryName string Directory name of unpacked tarball.
$_hordeVersionString string Major version number of Horde compatible to this release.
$_latest boolean Whether or not this is a final release version.
$_makeDiff boolean Whether or not to create a patch file.
$_newSourceVersionString string Version number of next release.
$_newSourceVersionStringPlain string Version number of next release for docs/CHANGES.
$_oldChangelogVersion string Revision number of previous CHANGES file.
$_oldDirectoryName string Directory name of unpacked previous tarball.
$_oldHordeVersionString string Major version number of Horde compatible to the previous release.
$_oldSourceVersionString string Version number of previous release.
$_oldTagVersionString string CVS tag of previous release.
$_oldVersion boolean Whether or not we have an old version to compare against.
$_options array Default options.
$_patchMD5 string MD5 sum of the patch file.
$_patchName string Filename of the gzip'ed patch file (without .gz extension).
$_sourceVersionString string Version number of release.
$_tagVersionString string CVS tag of release.
$_tarballMD5 string MD5 sum of the tarball.
$_tarballName string Filename of the tarball.
$_ticketVersion string Version string to use in Whups
$_ticketVersionDesc string Version description to use in Whups

Public Methods

Method Description
__construct ( $options = [] ) Load the configuration
__get ( $property )
addWhupsVersion ( ) Add the new version to bugs.horde.org
announce ( $doc_dir = null ) announce release to mailing lists.
checkArguments ( ) Check the command-line arguments and set some internal defaults
checkOutFramework ( $mod_version, $directory ) Checkout and install framework
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
checkSetSystem ( ) Check the command-line arguments and set some internal defaults
cleanDirectories ( $directory ) work through the source directory given, cleaning things up by removing directories and files we don't want in the tarball
deleteDirectory ( $directory ) Delete the directory given as an argument
diff ( ) Make a diff of the two directories given as arguments
getArguments ( ) Get all of the command-line arguments from the user
makeTarball ( ) tar and gzip the directory given as an argument
print_usage ( $message = null ) Show people how to use the damned thing
saveChangelog ( $old = false, $directory = null ) get and save the revision number of the CHANGES file
setVersionStrings ( ) Set the version strings to use given the arguments
tagSource ( $directory = null, $version = null ) Label all of the source here with the new label given as an argument
test ( ) Do testing (development only)
updateSentinel ( ) Update the CHANGES file with the new version number
updateVersionFile ( $directory, $version_string ) Change the version file for the module in the directory specified to the version specified
upload ( ) Upload tarball to the FTP server

Method Details

__construct() public method

Load the configuration
public __construct ( $options = [] )

__get() public method

public __get ( $property )

addWhupsVersion() public method

Add the new version to bugs.horde.org
public addWhupsVersion ( )

announce() public method

announce release to mailing lists.
public announce ( $doc_dir = null )

checkArguments() public method

Check the command-line arguments and set some internal defaults
public checkArguments ( )

checkOutFramework() public method

Checkout and install framework
public checkOutFramework ( $mod_version, $directory )

checkOutTag() public method

Check out the tag we've been given to work with and move it to the directory name given
public checkOutTag ( $mod_version, $directory, $module = null )

checkSetSystem() public method

Check the command-line arguments and set some internal defaults
public checkSetSystem ( )

cleanDirectories() public method

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

deleteDirectory() public method

Delete the directory given as an argument
public deleteDirectory ( $directory )

diff() public method

Make a diff of the two directories given as arguments
public diff ( )

getArguments() public method

Get all of the command-line arguments from the user
public getArguments ( )

makeTarball() public method

tar and gzip the directory given as an argument
public makeTarball ( )

print_usage() public method

Show people how to use the damned thing
public print_usage ( $message = null )

saveChangelog() public method

get and save the revision number of the CHANGES file
public saveChangelog ( $old = false, $directory = null )

setVersionStrings() public method

Set the version strings to use given the arguments
public setVersionStrings ( )

tagSource() public method

Label all of the source here with the new label given as an argument
public tagSource ( $directory = null, $version = null )

test() public method

Do testing (development only)
public test ( )

updateSentinel() public method

Update the CHANGES file with the new version number
public updateSentinel ( )

updateVersionFile() public method

Change the version file for the module in the directory specified to the version specified
public updateVersionFile ( $directory, $version_string )

upload() public method

Upload tarball to the FTP server
public upload ( )

Property Details

$_binaryDiffs protected_oe property

The list of binary diffs.
protected array $_binaryDiffs
return array

$_changelogVersion protected_oe property

Revision number of CHANGES file.
protected string $_changelogVersion
return string

$_directoryName protected_oe property

Directory name of unpacked tarball.
protected string $_directoryName
return string

$_hordeVersionString protected_oe property

Major version number of Horde compatible to this release.
protected string $_hordeVersionString
return string

$_latest protected_oe property

Whether or not this is a final release version.
protected bool $_latest
return boolean

$_makeDiff protected_oe property

Whether or not to create a patch file.
protected bool $_makeDiff
return boolean

$_newSourceVersionString protected_oe property

Version number of next release.
protected string $_newSourceVersionString
return string

$_newSourceVersionStringPlain protected_oe property

Version number of next release for docs/CHANGES.
protected string $_newSourceVersionStringPlain
return string

$_oldChangelogVersion protected_oe property

Revision number of previous CHANGES file.
protected string $_oldChangelogVersion
return string

$_oldDirectoryName protected_oe property

Directory name of unpacked previous tarball.
protected string $_oldDirectoryName
return string

$_oldHordeVersionString protected_oe property

Major version number of Horde compatible to the previous release.
protected string $_oldHordeVersionString
return string

$_oldSourceVersionString protected_oe property

Version number of previous release.
protected string $_oldSourceVersionString
return string

$_oldTagVersionString protected_oe property

CVS tag of previous release.
protected string $_oldTagVersionString
return string

$_oldVersion protected_oe property

Whether or not we have an old version to compare against.
protected bool $_oldVersion
return boolean

$_options protected_oe property

Default options.
protected array $_options
return array

$_patchMD5 protected_oe property

MD5 sum of the patch file.
protected string $_patchMD5
return string

$_patchName protected_oe property

Filename of the gzip'ed patch file (without .gz extension).
protected string $_patchName
return string

$_sourceVersionString protected_oe property

Version number of release.
protected string $_sourceVersionString
return string

$_tagVersionString protected_oe property

CVS tag of release.
protected string $_tagVersionString
return string

$_tarballMD5 protected_oe property

MD5 sum of the tarball.
protected string $_tarballMD5
return string

$_tarballName protected_oe property

Filename of the tarball.
protected string $_tarballName
return string

$_ticketVersion protected_oe property

Version string to use in Whups
protected string $_ticketVersion
return string

$_ticketVersionDesc protected_oe property

Version description to use in Whups
protected string $_ticketVersionDesc
return string

$notes public_oe property

May be refactored to use a setter for each property the release notes sets...
public array $notes
return array