Part of twisted.python View Source
Twisted's automated release system.
This module is only for use within Twisted's release system. If you are anyone else, do not use it. The interface and behaviour will change without notice.
Only Linux is supported by this code. It should not be used by any tools which must run on multiple platforms (eg the setup.py script).Function | runCommand | Execute a vector of arguments. |
Class | CommandFailed | Raised when a child process exits unsuccessfully. |
Function | getNextVersion | Calculate the version number for a new release of Twisted based on |
Function | changeAllProjectVersions | Change the version of all projects (including core and all subprojects). |
Class | Project | A representation of a project that has a version. |
Function | findTwistedProjects | Find all Twisted-style projects beneath a base directory. |
Function | updateTwistedVersionInformation | Update the version information for Twisted and all subprojects to the |
Function | generateVersionFileData | Generate the data to be placed into a _version.py file. |
Function | replaceProjectVersion | Write version specification code into the given filename, which |
Function | replaceInFile | I replace the text `oldstr' with `newstr' in `filename' using science. |
Class | NoDocumentsFound | Raised when no input documents are found. |
Class | LoreBuilderMixin | Base class for builders which invoke lore. |
Class | DocBuilder | Generate HTML documentation for projects. |
Class | ManBuilder | Generate man pages of the different existing scripts. |
Class | APIBuilder | Generate API documentation from source files using |
Class | BookBuilder | Generate the LaTeX and PDF documentation. |
Class | NewsBuilder | Generate the new section of a NEWS file. |
Function | filePathDelta | Return a list of strings that represent destination as a
path relative
|
Class | DistributionBuilder | A builder of Twisted distributions. |
Class | UncleanWorkingDirectory | Raised when the working directory of an SVN checkout is unclean. |
Class | NotWorkingDirectory | Raised when a directory does not appear to be an SVN working directory. |
Function | buildAllTarballs | Build complete tarballs (including documentation) for Twisted and all |
Class | ChangeVersionsScript | A thing for changing version numbers. See main .
|
Class | BuildTarballsScript | A thing for building release tarballs. See main .
|
Class | BuildAPIDocsScript | A thing for building API documentation. See main .
|
Function | _changeVersionInFile | Replace the old version number with the new
one in the given
|
Parameters | args | A list of arguments, the first of which will be used as the executable
to run.
(type: list of str
) |
Returns | All of the standard output.
(type: str
) | |
Raises | CommandFailed | when the program exited with a non-0 exit code. |
old
version number with the new
one in the given filename
.
Parameters | version | The previous version number. |
now | (optional) The current date. |
Parameters | baseDirectory | A twisted.python.filepath.FilePath
to look inside.
|
Returns | A list of Project .
|
Parameters | baseDirectory | Where to look for Twisted. If None, the function infers the information
from twisted.__file__ .
|
now | The current date (as datetime.date ). If None, it defaults
to today.
|
Parameters | version | A version object. |
Parameters | filename | A filename which is most likely a "_version.py" under some Twisted project. |
newversion | A version object. |
Return a list of strings that represent destination
as a
path relative to origin
.
twisted.python.filepath.FilePath
/foo/bar to twisted.python.filepath.FilePath
/foo/baz will be ../baz
, not baz
.
Parameters | origin | The origin of the relative path.
(type: twisted.python.filepath.FilePath
) |
destination | The destination of the relative path.
(type: twisted.python.filepath.FilePath
) |
Build complete tarballs (including documentation) for Twisted and all subprojects.
This should be called after the version numbers have been updated and NEWS files created.Parameters | checkout | The SVN working copy from which a pristine source tree will be
exported.
(type: FilePath
) |
destination | The directory in which tarballs will be placed.
(type: FilePath
) | |
Raises | UncleanWorkingDirectory | if there are modifications to the working directory of
checkout .
|
NotWorkingDirectory | if the checkout path is not an SVN checkout. |