@@ -12,6 +12,9 @@ import fabric.version _version = fabric.version.get_version +docs_host = 'jforcier@fabfile.org' + + def test(args=""): """ Run all unit tests and doctests. @@ -34,7 +37,7 @@ def build_docs(clean='no', browse='no'): local('cd docs; make %shtml%s' % (c, b), capture=False) -@hosts('jforcier@fabfile.org') +@hosts(docs_host) def push_docs(): """ Build and push the Sphinx docs to docs.fabfile.org @@ -47,19 +50,23 @@ def push_docs(): def _code_version_is_tagged(): return local('git tag | egrep "^%s$"' % _version('short')) -def _update_code_version(): +def _update_code_version(force): """ Update version data structure in-code and commit that change to git. + + Normally, if the version file has not been modified, we abort assuming the + user quit without saving. Specify ``force=yes`` to override this. """ + version_file = "fabric/version.py" raw_input("Work has been done since last tag, version update is needed. Hit Enter to load version info in your editor: ") - local("$EDITOR fabric/version.py", capture=False) + local("$EDITOR %s" % version_file, capture=False) # Try to detect whether user bailed out of the edit - if not local('git diff -- fabric/version.py'): + if not local("git diff -- %s" % version_file) and not force: abort("You seem to have aborted the file edit, so I'm aborting too.") # Reload version module to get new version reload(fabric.version) # Commit the version update - local("git add fabric/version.py", capture=False) + local("git add %s" % version_file, capture=False) local("git commit -m \"Cut %s\"" % _version('verbose'), capture=False) def _commits_since_tag(): @@ -68,34 +75,67 @@ def _commits_since_tag(): """ return local("git log %s.." % _version('short')) -def tag(): +def tag(force='no', push='no'): """ - Tag a new release of the software + Tag a new release. + + Normally, if a Git tag exists matching the current version, and no Git + commits appear after that tag, we abort assuming the user is making a + mistake or forgot to commit their work. + + To override this -- i.e. to re-tag and re-upload -- specify ``force=yes``. + We assume you know what you're doing if you use this. + + By default we do not push the tag remotely; specify ``push=yes`` to force a + ``git push origin <tag>``. """ + force = force.lower() in ['y', 'yes'] with settings(warn_only=True): # Does the current in-code version exist as a Git tag already? # If so, this means we haven't updated the in-code version specifier # yet, and need to do so. if _code_version_is_tagged(): # That is, if any work has been done since. Sanity check! - if not _commits_since_tag(): + if not _commits_since_tag() and not force: abort("No work done since last tag!") # Open editor, update version, commit that change to Git. - _update_code_version() + _update_code_version(force) # If the tag doesn't exist, the user has already updated version info # and we can just move on. else: print("Version has already been updated, no need to edit...") # At this point, we've incremented the in-code version and just need to # tag it in Git. - local("git tag -am \"Fabric %s\" %s" % ( + f = 'f' if force else '' + local("git tag -%sam \"Fabric %s\" %s" % ( + f, _version('verbose'), _version('short') ), capture=False) + # And push to the central server, if we were told to + if push.lower() in ['y', 'yes']: + local("git push origin %s" % _version('short'), capture=False) def build(): """ - Create distribution package via setup.py + Build (but don't upload) via setup.py """ local('python setup.py sdist', capture=False) + + +def upload(): + """ + Build, register and upload to PyPI + """ + local('python setup.py sdist register upload', capture=False) + + +def release(force='no'): + """ + Tag/push, build, upload new version and build/upload documentation. + """ + tag(force=force, push='yes') + upload() + with settings(host_string=docs_host): + push_docs() fabfile.py a69dde19c5be0e4d5c83464c0deabe943a128550 Jeff Forcier jeff@bitprophet.org http://github.com/bitprophet/fabric/commit/63082f8dfd2094139903f85be78d08accf50e748 63082f8dfd2094139903f85be78d08accf50e748 2009-11-08T16:38:37-08:00 2009-11-08T16:38:37-08:00 Add release task and related tasks. 7f789660e8f98934f1b37f8aaf47cff984c54f2b Jeff Forcier jeff@bitprophet.org