Skip to content

Schemas

Schemas and data structures for PR generation.

WorkflowStrategySchema module-attribute 

WorkflowStrategySchema = Literal[
	"github-flow", "gitflow", "trunk-based"
]

BranchType module-attribute 

BranchType = Literal[
	"feature", "release", "hotfix", "bugfix", "docs"
]

PRContent

Bases: TypedDict

Pull request content type.

Source code in src/codemap/git/pr_generator/schemas.py 
13
14
15
16
17
class PRContent(TypedDict):
	"""Pull request content type."""

	title: str
	description: str

title instance-attribute 

title: str

description instance-attribute 

description: str

PullRequest dataclass

Represents a GitHub Pull Request.

Source code in src/codemap/git/pr_generator/schemas.py 
20
21
22
23
24
25
26
27
28
@dataclass
class PullRequest:
	"""Represents a GitHub Pull Request."""

	branch: str
	title: str
	description: str
	url: str | None = None
	number: int | None = None

__init__ 

__init__(
	branch: str,
	title: str,
	description: str,
	url: str | None = None,
	number: int | None = None,
) -> None

branch instance-attribute 

branch: str

title instance-attribute 

title: str

description instance-attribute 

description: str

url class-attribute instance-attribute 

url: str | None = None

number class-attribute instance-attribute 

number: int | None = None