cumulusci.tasks.github package

Submodules

class cumulusci.tasks.github.base.BaseGithubTask(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.core.tasks.BaseTask

get_repo()[source]
class cumulusci.tasks.github.merge.MergeBranch(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'branch_prefix': {'description': 'The prefix of branches that should receive the merge. Defaults to project__git__prefix_feature'}, 'children_only': {'description': 'If True, merge will only be done to child branches. This assumes source branch is a parent feature branch. Defaults to False'}, 'commit': {'description': 'The commit to merge into feature branches. Defaults to the current head commit.'}, 'source_branch': {'description': 'The source branch to merge from. Defaults to project__git__default_branch.'}}
class cumulusci.tasks.github.pull_request.PullRequests(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

class cumulusci.tasks.github.release.CreateRelease(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'commit': {'description': 'Override the commit used to create the release. Defaults to the current local HEAD commit'}, 'dependencies': {'description': 'List of dependencies to record in the tag message.'}, 'message': {'description': 'The message to attach to the created git tag'}, 'version': {'description': 'The managed package version number. Ex: 1.2', 'required': True}}
class cumulusci.tasks.github.release_report.ReleaseReport(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

DATE_FORMAT = '%Y-%m-%d'
task_options = {'date_end': {'description': 'Filter out releases created after this date (YYYY-MM-DD)'}, 'date_start': {'description': 'Filter out releases created before this date (YYYY-MM-DD)'}, 'include_beta': {'description': 'Include beta releases in report [default=False]'}, 'print': {'description': 'Print info to screen as JSON [default=False]'}}
class cumulusci.tasks.github.tag.CloneTag(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'src_tag': {'description': 'The source tag to clone. Ex: beta/1.0-Beta_2', 'required': True}, 'tag': {'description': 'The new tag to create by cloning the src tag. Ex: release/1.0', 'required': True}}
class cumulusci.tasks.github.util.CommitDir(repo, logger=None, author=None)[source]

Bases: object

Commit all changes in local_dir to branch/repo_dir

Module contents

class cumulusci.tasks.github.MergeBranch(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'branch_prefix': {'description': 'The prefix of branches that should receive the merge. Defaults to project__git__prefix_feature'}, 'children_only': {'description': 'If True, merge will only be done to child branches. This assumes source branch is a parent feature branch. Defaults to False'}, 'commit': {'description': 'The commit to merge into feature branches. Defaults to the current head commit.'}, 'source_branch': {'description': 'The source branch to merge from. Defaults to project__git__default_branch.'}}
class cumulusci.tasks.github.PullRequests(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

class cumulusci.tasks.github.CreateRelease(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'commit': {'description': 'Override the commit used to create the release. Defaults to the current local HEAD commit'}, 'dependencies': {'description': 'List of dependencies to record in the tag message.'}, 'message': {'description': 'The message to attach to the created git tag'}, 'version': {'description': 'The managed package version number. Ex: 1.2', 'required': True}}
class cumulusci.tasks.github.ReleaseReport(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

DATE_FORMAT = '%Y-%m-%d'
task_options = {'date_end': {'description': 'Filter out releases created after this date (YYYY-MM-DD)'}, 'date_start': {'description': 'Filter out releases created before this date (YYYY-MM-DD)'}, 'include_beta': {'description': 'Include beta releases in report [default=False]'}, 'print': {'description': 'Print info to screen as JSON [default=False]'}}
class cumulusci.tasks.github.CloneTag(project_config, task_config, org_config=None, flow=None, name=None, stepnum=None, **kwargs)[source]

Bases: cumulusci.tasks.github.base.BaseGithubTask

task_options = {'src_tag': {'description': 'The source tag to clone. Ex: beta/1.0-Beta_2', 'required': True}, 'tag': {'description': 'The new tag to create by cloning the src tag. Ex: release/1.0', 'required': True}}