ctl.plugins.repository

Plugin interface for plugins that manage software repositories

Classes

PluginConfig(confu.schema.core.Schema)

Configuration schema for RepositoryPlugin

branch (Str): Checkout this branch
checkout_path (Directory): checkout to this local location - if not specified will default to ~/.ctl/cache/{repo_url}
repo_url (Str):

RepositoryPlugin(ctl.plugins.ExecutablePlugin)

Interface for repository type plugins

These attributes / properties will be available on instances of the class

branch (@property): Should return the name of the current branch
is_clean (@property): Should perform a clean check (eg. git status --porcelain) and return True if clean, False if not
is_cloned (@property): should return True or False depending on whether the repository is already cloned at checkout_path or not
repo_ctl_dir (@property): location of ctl directory inside repository
uuid (@property): should return current commit hash/id
version (@property): current version as it exists in version_file
version_file (@property): location of version file

def __repr__(self)

Return repr(self).

def branch_exists(self, name)

Should return True if the branch with the name exists in the local repository, False otherwise

def checkout(self, branch, **kwargs)

Should checkout a branch by name

def clone(self, **kwargs)

Should clone the repository according to config parameters repo_url and checkout_path

def commit(self, **kwargs)

Should commit changes

Keyword arguments

files (list): list of files to commit, should be filenames relative to the repo root
message (str): commit message
push (bool=True): push immediately

def init(self)

called after the plugin is initialized, plugin may define this for any other initialization code

def merge(self, branch_a, branch_b, **kwargs)

Should merge branch b into branch a

def pull(self, **kwargs)

Should pull the repository

def push(self, **kwargs)

Should push changes to the remote

def tag(self, version, **kwargs)

Should tag the current branch