boilerdata_tools.add_changes

Add changes.

Module Contents

Classes

Issue	Issue.
Change	Change.

Functions

add_change	Add change.
get_issue_from_active_branch	Get issue associated with active branch.
get_change	Get related issue title.
get_connected_prs	Get first PR connected to an issue.
query_gh_issue	Query GitHub for an issue.
sanitize	Sanitize query.

API

boilerdata_tools.add_changes.add_change(

typ: boilerdata_tools.types.ChangeType = 'change',

)

Add change.

class boilerdata_tools.add_changes.Issue

Bases: typing.NamedTuple

Issue.

owner: str

None

Owner.

repo: str

None

Repository.

issue: int

None

Issue.

boilerdata_tools.add_changes.get_issue_from_active_branch() → boilerdata_tools.add_changes.Issue

Get issue associated with active branch.

class boilerdata_tools.add_changes.Change

Change.

id: int

None

ID.

name: str

None

Name.

boilerdata_tools.add_changes.get_change(

owner: str,

repo: str,

issue: int,

) → boilerdata_tools.add_changes.Change

Get related issue title.

boilerdata_tools.add_changes.get_connected_prs(

owner: str,

repo: str,

issue: int,

first: int,

) → list[dict[str, Any]]

Get first PR connected to an issue.

boilerdata_tools.add_changes.query_gh_issue(

owner: str,

repo: str,

issue: int,

query: str = 'title',

) → dict[str, Any]

Query GitHub for an issue.

boilerdata_tools.add_changes.sanitize(

query: str,

) → str

Sanitize query.