BitTorrentBuilder

BitTorrentBuilder: BitTorrent torrent file builder based on the CreateTorrent utility by Daniel Etzold

Super Type: Builder

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory
Data View	Children, proximity: 1
Logger Name	BitTorrentBuilder

Allowed Child Dependencies

BitTorrentBuilderPieceLength ¹
BitTorrentBuilderPort ¹
BitTorrentBuilderUrl ¹
BuilderBuildFile¹
BuilderBuildstamp¹
BuilderBuildTarget¹
BuilderExportDestination¹
BuilderImportMax¹
BuilderImportMin¹
BuilderPackageBuildtimePattern¹
BuilderPackageExtension¹
BuilderPackageFilebase¹
BuilderPackageInstallRank¹
BuilderPackageInstallroot¹
BuilderPackagePurgeRegex¹
BuilderPackageRequireBuildstamp¹
BuilderPackageSeparator¹
BuilderPackageType¹
BuilderPackageVendor¹
BuilderPackageVersion¹
BuilderScmBinding¹
BuilderScmConnection¹
BuilderScmLabel¹
BuilderScmModule¹
BuilderScmQuiet¹
BuilderScmUser¹
BuilderScmView¹
BuilderVersionBuild¹
BuilderVersionMajor¹
BuilderVersionMinor¹
BuilderVersionRelease¹
BuilderVersionTag¹

¹: These types have a Singleton constraint. Only one instance may be added as a resource.

Defaults for Imported Attributes

Name	Default
packageExtension	torrent
packageFilebase	${entity.name}
packageInstallroot	${entity.attribute.basedir}
packageType	BitTorrentFile
pieceLength	262144
trackerPort	6881

Note

Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

Build

Run the build cycle.

Usage: Build [-buildstamp <>]

Workflow

setBuildstamp
runBuildScript
repoImport

Options

Option	Description
buildstamp	build identifier

runBuildScript

runs the build script

Usage: runBuildScript [-basedir <>] [-buildfile <>] [-buildstamp <>] [-filebase <>] [-piecelength <>] [-port <>] [-target <>] [-targetdir <>] [-url <>]

Execution	bash
Arguments	mkdir -p ${opts.targetdir}; createtorrent -a ${opts.url} -p ${opts.port} -l ${opts.piecelength} --comment ${opts.basedir} ${opts.targetdir}/${opts.filebase}.torrent

Options

Option	Description
basedir	directory where build resources reside
buildfile	build file to execute
buildstamp	build identifier
filebase	torrent file name
piecelength	piece length to use for the tracker file
port	tracker port to include in the torrent file
target	build target to evaluate
targetdir	directory build artifacts will be written
url	tracker url to include in the torrent file

The following types are defined for use with BitTorrentBuilder.