xia_engine_gitlab.engine_issue.GitlabMilestoneIssueEngineClient

class xia_engine_gitlab.engine_issue.GitlabMilestoneIssueEngineClient(api_host: str, api_token: str, **kwargs)

Bases: GitlabEngineClient

Issue management with Milestone as parent node

__init__(api_host: str, api_token: str, **kwargs)

Methods

__init__(api_host, api_token, **kwargs)
check_file_exists(project_id, branch, path)
check_response(response)
commit_file(project_id, branch, path, ...[, ...])
create_branch(project_id, branch_name, ref)
create_issue(project_name, parent_name, ...)
create_label_if_not_exists(project_name, ...)
create_merge_request(project_id, title, ...)
delete_branch(project_id, branch_name)
delete_issue(project_name, issue_name, **kwargs)
get_branch_info(project_id, branch_name)
get_default_branch_from_name(api_endpoint, ...)	Get default branch name from the given name
get_file_content(project_id, branch, path[, ...])	Get file content
get_group_id_from_name(api_endpoint, ...)
get_issue(project_name, issue_name, **kwargs)
get_issue_branch_name(issue_name, issue_iid)
get_issue_commit_name(issue_name, issue_iid)
get_issue_iid_from_name(api_endpoint, ...)
get_issue_mr_name(issue_name, issue_iid)
get_merge_request_commits(project_id, title)
get_milestone_branch_name(milestone_name)
get_milestone_id_from_name(api_endpoint, ...)
get_milestone_info_from_issue(api_endpoint, ...)
get_milestone_mr_name(milestone_name)
get_mr_iid_from_branch(api_endpoint, ...[, ...])
get_mr_iid_from_name(api_endpoint, ...)
get_mr_iid_from_title(api_endpoint, ...)
get_project_id_from_name(api_endpoint, ...)
list_issue(**kwargs)
merge_merge_request(project_id, title[, ...])
on_issue_notification(project_name, issue_name)	When need to notify the issue changes
on_issue_validated(project_name, issue_name)	Merge the merge request to target branch when the issue has been validated (review passed + pipeline ok)
pipeline_exists(api_endpoint, api_token, ...)
rebase_merge_request(project_id, title)
split_header_body(full_content)
trigger_pipeline(project_name, issue_name[, ...])
update_issue(project_name, issue_name, ...)	Update issue page

classmethod get_default_branch_from_name(api_endpoint: str, api_token: str, project_id: int) → str

Get default branch name from the given name

Parameters

• api_endpoint –

• api_token –

• project_id –

Returns:

get_file_content(project_id, branch: str, path: str, with_encoding: bool = False)

Get file content

Returns

when with_encoding is true and the content is binary, will return base64 string instead binary result

on_issue_notification(project_name: str, issue_name: str)

When need to notify the issue changes

Parameters

• project_name – Project Name

• issue_name – Issue Name

on_issue_validated(project_name: str, issue_name: str)

Merge the merge request to target branch when the issue has been validated (review passed + pipeline ok)

Parameters

• project_name – Project Name

• issue_name – Issue Name

update_issue(project_name: str, issue_name: str, issue_content: str, **kwargs)

Update issue page

Parameters

• project_name – Project name

• issue_name – document id

• issue_content – database content