makerelease Namespace Reference

Classes
class	SFTPError
class	SVNError

Functions
def	set_version (version)
def	rmdir_if_exist (dir_path)
def	svn_command (command, args)
def	check_no_pending_commit ()
def	svn_join_url (base_url, suffix)
def	svn_check_if_tag_exist (tag_url)
def	svn_commit (message)
def	svn_tag_sandbox (tag_url, message)
def	svn_remove_tag (tag_url, message)
def	svn_export (tag_url, export_dir)
def	fix_sources_eol (dist_dir)
def	download (url, target_path)
def	check_compile (distcheck_top_dir, platform)
def	write_tempfile (content, kwargs)
def	run_sftp_batch (userhost, sftp, batch, retry=0)
def	sourceforge_web_synchro (sourceforge_project, doc_dir, user=None, sftp='sftp')
def	sourceforge_release_tarball (sourceforge_project, paths, user=None, sftp='sftp')
def	main ()

Variables
string	SVN_ROOT = 'https://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/'
string	SVN_TAG_ROOT = SVN_ROOT + 'tags/jsoncpp'
string	SCONS_LOCAL_URL = 'http://sourceforge.net/projects/scons/files/scons-local/1.2.0/scons-local-1.2.0.tar.gz/download'
string	SOURCEFORGE_PROJECT = 'jsoncpp'
	doc_tarball_path
	doc_dirname = r'jsoncpp-api-html-0.5.0' doc_tarball_path = r'e:-trunk\dist\jsoncpp-api-html-0.5.0.tar.gz' More...
	doc_dirname
	options
	make_release
string	doc_distcheck_dir = 'dist/doccheck'
	doc_distcheck_top_dir = os.path.join( doc_distcheck_dir, doc_dirname )
string	export_dir = 'dist/export'
string	source_dir = 'jsoncpp-src-' + release_version
string	source_tarball_path = 'dist/%s.tar.gz' % source_dir
	prefix_dir
string	amalgamation_tarball_path = 'dist/%s-amalgamation.tar.gz' % source_dir
string	amalgamation_dir = 'dist/amalgamation'
string	amalgamation_source_dir = 'jsoncpp-src-amalgamation' + release_version
string	distcheck_dir = 'dist/distcheck'
string	distcheck_top_dir = distcheck_dir + '/' + source_dir
string	scons_local_path = 'dist/scons-local.tar.gz'
bool	all_build_status = True
	build_status
	log_path
	user
	sftp

Detailed Description

Tag the sandbox for release, make source and doc tarballs.

Requires Python 2.6

Example of invocation (use to test the script):
python makerelease.py --platform=msvc6,msvc71,msvc80,msvc90,mingw -ublep 0.6.0 0.7.0-dev

When testing this script:
python makerelease.py --force --retag --platform=msvc6,msvc71,msvc80,mingw -ublep test-0.6.0 test-0.6.1-dev

Example of invocation when doing a release:
python makerelease.py 0.5.0 0.6.0-dev

Function Documentation

check_compile()

def makerelease.check_compile	(		distcheck_top_dir,
			platform
	)

check_no_pending_commit()

def makerelease.check_no_pending_commit

(

)

Checks that there is no pending commit in the sandbox.

download()

def makerelease.download	(		url,
			target_path
	)

Download file represented by url to target_path.

fix_sources_eol()

def makerelease.fix_sources_eol

(

dist_dir

)

Set file EOL for tarball distribution.

main()

def makerelease.main

(

void

)

rmdir_if_exist()

def makerelease.rmdir_if_exist

(

dir_path

)

run_sftp_batch()

def makerelease.run_sftp_batch	(		userhost,
			sftp,
			batch,
			retry = 0
	)

set_version()

def makerelease.set_version

(

version

)

sourceforge_release_tarball()

def makerelease.sourceforge_release_tarball	(		sourceforge_project,
			paths,
			user = None,
			sftp = 'sftp'
	)

sourceforge_web_synchro()

def makerelease.sourceforge_web_synchro	(		sourceforge_project,
			doc_dir,
			user = None,
			sftp = 'sftp'
	)

Notes: does not synchronize sub-directory of doc-dir.

svn_check_if_tag_exist()

def makerelease.svn_check_if_tag_exist

(

tag_url

)

Checks if a tag exist.
Returns: True if the tag exist, False otherwise.

svn_command()

def makerelease.svn_command	(		command,
			args
	)

svn_commit()

def makerelease.svn_commit

(

message

)

Commit the sandbox, providing the specified comment.

svn_export()

def makerelease.svn_export	(		tag_url,
			export_dir
	)

Exports the tag_url revision to export_dir.
   Target directory, including its parent is created if it does not exist.
   If the directory export_dir exist, it is deleted before export proceed.

svn_join_url()

def makerelease.svn_join_url	(		base_url,
			suffix
	)

svn_remove_tag()

def makerelease.svn_remove_tag	(		tag_url,
			message
	)

Removes an existing tag.

svn_tag_sandbox()

def makerelease.svn_tag_sandbox	(		tag_url,
			message
	)

Makes a tag based on the sandbox revisions.

write_tempfile()

def makerelease.write_tempfile	(		content,
			kwargs
	)

Variable Documentation

all_build_status

bool makerelease.all_build_status = True

amalgamation_dir

makerelease.amalgamation_dir = 'dist/amalgamation'

amalgamation_source_dir

string makerelease.amalgamation_source_dir = 'jsoncpp-src-amalgamation' + release_version

amalgamation_tarball_path

string makerelease.amalgamation_tarball_path = 'dist/%s-amalgamation.tar.gz' % source_dir

build_status

makerelease.build_status

distcheck_dir

string makerelease.distcheck_dir = 'dist/distcheck'

distcheck_top_dir

string makerelease.distcheck_top_dir = distcheck_dir + '/' + source_dir

doc_dirname

makerelease.doc_dirname

doc_distcheck_dir

string makerelease.doc_distcheck_dir = 'dist/doccheck'

doc_distcheck_top_dir

makerelease.doc_distcheck_top_dir = os.path.join( doc_distcheck_dir, doc_dirname )

doc_tarball_path

makerelease.doc_tarball_path

doc_dirname = r'jsoncpp-api-html-0.5.0' doc_tarball_path = r'e:-trunk\dist\jsoncpp-api-html-0.5.0.tar.gz'

export_dir

makerelease.export_dir = 'dist/export'

log_path

makerelease.log_path

make_release

makerelease.make_release

options

makerelease.options

prefix_dir

makerelease.prefix_dir

scons_local_path

string makerelease.scons_local_path = 'dist/scons-local.tar.gz'

SCONS_LOCAL_URL

string makerelease.SCONS_LOCAL_URL = 'http://sourceforge.net/projects/scons/files/scons-local/1.2.0/scons-local-1.2.0.tar.gz/download'

sftp

makerelease.sftp

source_dir

string makerelease.source_dir = 'jsoncpp-src-' + release_version

source_tarball_path

string makerelease.source_tarball_path = 'dist/%s.tar.gz' % source_dir

SOURCEFORGE_PROJECT

makerelease.SOURCEFORGE_PROJECT = 'jsoncpp'

SVN_ROOT

string makerelease.SVN_ROOT = 'https://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/'

SVN_TAG_ROOT

string makerelease.SVN_TAG_ROOT = SVN_ROOT + 'tags/jsoncpp'

user

makerelease.user