Strategies
Git workflow strategy implementations for PR management.
WorkflowStrategy
Bases: ABC
Base class for git workflow strategies.
Source code in src/codemap/git/pr_generator/strategies.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
|
get_default_base
abstractmethod
get_default_base(branch_type: str) -> str | None
Get the default base branch for a given branch type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
Returns:
Type | Description |
---|---|
str | None
|
Name of the default base branch |
Source code in src/codemap/git/pr_generator/strategies.py
28 29 30 31 32 33 34 35 36 37 38 39 40 |
|
suggest_branch_name
suggest_branch_name(
branch_type: str, description: str
) -> str
Suggest a branch name based on the workflow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
description
|
str
|
Description of the branch |
required |
Returns:
Type | Description |
---|---|
str
|
Suggested branch name |
Source code in src/codemap/git/pr_generator/strategies.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
get_branch_prefix
abstractmethod
get_branch_prefix(branch_type: str) -> str
Get the branch name prefix for a given branch type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
Returns:
Type | Description |
---|---|
str
|
Branch name prefix |
Source code in src/codemap/git/pr_generator/strategies.py
58 59 60 61 62 63 64 65 66 67 68 69 70 |
|
get_branch_types
abstractmethod
get_branch_types() -> list[str]
Get valid branch types for this workflow.
Returns:
Type | Description |
---|---|
list[str]
|
List of valid branch types |
Source code in src/codemap/git/pr_generator/strategies.py
72 73 74 75 76 77 78 79 80 81 |
|
detect_branch_type
detect_branch_type(branch_name: str | None) -> str | None
Detect the type of a branch from its name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_name
|
str | None
|
Name of the branch |
required |
Returns:
Type | Description |
---|---|
str | None
|
Branch type or None if not detected |
Source code in src/codemap/git/pr_generator/strategies.py
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
|
get_pr_templates
get_pr_templates(branch_type: str) -> dict[str, str]
Get PR title and description templates for a given branch type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
Returns:
Type | Description |
---|---|
dict[str, str]
|
Dictionary with 'title' and 'description' templates |
Source code in src/codemap/git/pr_generator/strategies.py
100 101 102 103 104 105 106 107 108 109 110 111 |
|
get_remote_branches
get_remote_branches() -> list[str]
Get list of remote branches.
Returns:
Type | Description |
---|---|
list[str]
|
List of remote branch names (without 'origin/' prefix typically) |
Source code in src/codemap/git/pr_generator/strategies.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
|
get_local_branches
get_local_branches() -> list[str]
Get list of local branches.
Returns:
Type | Description |
---|---|
list[str]
|
List of local branch names |
Source code in src/codemap/git/pr_generator/strategies.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
|
get_branches_by_type
get_branches_by_type() -> dict[str, list[str]]
Group branches by their type.
Returns:
Type | Description |
---|---|
dict[str, list[str]]
|
Dictionary mapping branch types to lists of branch names |
Source code in src/codemap/git/pr_generator/strategies.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
get_branch_metadata
get_branch_metadata(branch_name: str) -> dict[str, Any]
Get metadata for a specific branch.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_name
|
str
|
Name of the branch |
required |
Returns:
Type | Description |
---|---|
dict[str, Any]
|
Dictionary with branch metadata |
Source code in src/codemap/git/pr_generator/strategies.py
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
|
get_all_branches_with_metadata
get_all_branches_with_metadata() -> dict[
str, dict[str, Any]
]
Get all branches with metadata.
Returns:
Type | Description |
---|---|
dict[str, dict[str, Any]]
|
Dictionary mapping branch names to metadata dictionaries |
Source code in src/codemap/git/pr_generator/strategies.py
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
|
GitHubFlowStrategy
Bases: WorkflowStrategy
Implementation of GitHub Flow workflow strategy.
Source code in src/codemap/git/pr_generator/strategies.py
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
|
get_default_base
get_default_base(branch_type: str) -> str | None
Get the default base branch for GitHub Flow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (always 'feature' in GitHub Flow) |
required |
Returns:
Type | Description |
---|---|
str | None
|
Name of the default base branch (usually 'main') |
Source code in src/codemap/git/pr_generator/strategies.py
283 284 285 286 287 288 289 290 291 292 293 294 295 |
|
get_branch_prefix
get_branch_prefix(branch_type: str) -> str
Get the branch name prefix for GitHub Flow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (always 'feature' in GitHub Flow) |
required |
Returns:
Type | Description |
---|---|
str
|
Branch name prefix (empty string for GitHub Flow) |
Source code in src/codemap/git/pr_generator/strategies.py
297 298 299 300 301 302 303 304 305 306 307 308 309 |
|
get_branch_types
get_branch_types() -> list[str]
Get valid branch types for GitHub Flow.
Returns:
Type | Description |
---|---|
list[str]
|
List containing only 'feature' |
Source code in src/codemap/git/pr_generator/strategies.py
311 312 313 314 315 316 317 318 319 |
|
get_pr_templates
get_pr_templates(branch_type: str) -> dict[str, str]
Get PR title and description templates for GitHub Flow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (always 'feature' in GitHub Flow) |
required |
Returns:
Type | Description |
---|---|
dict[str, str]
|
Dictionary with 'title' and 'description' templates |
Source code in src/codemap/git/pr_generator/strategies.py
321 322 323 324 325 326 327 328 329 330 331 332 |
|
GitFlowStrategy
Bases: WorkflowStrategy
Implementation of GitFlow workflow strategy.
Source code in src/codemap/git/pr_generator/strategies.py
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
|
get_default_base
get_default_base(branch_type: str) -> str | None
Get the default base branch for GitFlow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, bugfix) |
required |
Returns:
Type | Description |
---|---|
str | None
|
Name of the default base branch |
Source code in src/codemap/git/pr_generator/strategies.py
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
|
get_branch_prefix
get_branch_prefix(branch_type: str) -> str
Get the branch name prefix for GitFlow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
Returns:
Type | Description |
---|---|
str
|
Branch name prefix |
Source code in src/codemap/git/pr_generator/strategies.py
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
|
get_branch_types
get_branch_types() -> list[str]
Get valid branch types for GitFlow.
Returns:
Type | Description |
---|---|
list[str]
|
List of valid branch types for GitFlow |
Source code in src/codemap/git/pr_generator/strategies.py
377 378 379 380 381 382 383 384 385 |
|
suggest_branch_name
suggest_branch_name(
branch_type: str, description: str
) -> str
Suggest a branch name based on GitFlow conventions.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, etc.) |
required |
description
|
str
|
Description of the branch |
required |
Returns:
Type | Description |
---|---|
str
|
Suggested branch name |
Source code in src/codemap/git/pr_generator/strategies.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
|
get_pr_templates
get_pr_templates(branch_type: str) -> dict[str, str]
Get PR title and description templates for GitFlow.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch (feature, release, hotfix, bugfix) |
required |
Returns:
Type | Description |
---|---|
dict[str, str]
|
Dictionary with 'title' and 'description' templates |
Source code in src/codemap/git/pr_generator/strategies.py
410 411 412 413 414 415 416 417 418 419 420 421 |
|
TrunkBasedStrategy
Bases: WorkflowStrategy
Implementation of Trunk-Based Development workflow strategy.
Source code in src/codemap/git/pr_generator/strategies.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
|
get_default_base
get_default_base(branch_type: str) -> str | None
Get the default base branch for Trunk-Based Development.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch |
required |
Returns:
Type | Description |
---|---|
str | None
|
Name of the default base branch (trunk, which is usually 'main') |
Source code in src/codemap/git/pr_generator/strategies.py
427 428 429 430 431 432 433 434 435 436 437 438 439 |
|
get_branch_prefix
get_branch_prefix(branch_type: str) -> str
Get the branch name prefix for Trunk-Based Development.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch |
required |
Returns:
Type | Description |
---|---|
str
|
Branch name prefix |
Source code in src/codemap/git/pr_generator/strategies.py
441 442 443 444 445 446 447 448 449 450 451 452 |
|
get_branch_types
get_branch_types() -> list[str]
Get valid branch types for Trunk-Based Development.
Returns:
Type | Description |
---|---|
list[str]
|
List containing only 'feature' |
Source code in src/codemap/git/pr_generator/strategies.py
454 455 456 457 458 459 460 461 462 |
|
suggest_branch_name
suggest_branch_name(
branch_type: str, description: str
) -> str
Suggest a branch name based on Trunk-Based Development conventions.
Emphasizes short-lived, descriptive branches.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch |
required |
description
|
str
|
Description of the branch |
required |
Returns:
Type | Description |
---|---|
str
|
Suggested branch name |
Source code in src/codemap/git/pr_generator/strategies.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 |
|
get_pr_templates
get_pr_templates(branch_type: str) -> dict[str, str]
Get PR title and description templates for Trunk-Based Development.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_type
|
str
|
Type of branch |
required |
Returns:
Type | Description |
---|---|
dict[str, str]
|
Dictionary with 'title' and 'description' templates |
Source code in src/codemap/git/pr_generator/strategies.py
512 513 514 515 516 517 518 519 520 521 522 523 |
|
get_strategy_class
get_strategy_class(
strategy_name: str,
) -> type[WorkflowStrategy] | None
Get the workflow strategy class corresponding to the strategy name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strategy_name
|
str
|
Name of the workflow strategy |
required |
Returns:
Type | Description |
---|---|
type[WorkflowStrategy] | None
|
Workflow strategy class or None if not found |
Source code in src/codemap/git/pr_generator/strategies.py
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
|
create_strategy
create_strategy(strategy_name: str) -> WorkflowStrategy
Create a workflow strategy instance based on the strategy name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strategy_name
|
str
|
The name of the workflow strategy to create. |
required |
Returns:
Type | Description |
---|---|
WorkflowStrategy
|
An instance of the requested workflow strategy. |
Raises:
Type | Description |
---|---|
ValueError
|
If the strategy name is unknown. |
Source code in src/codemap/git/pr_generator/strategies.py
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
|
branch_exists
branch_exists(
branch_name: str,
pgu_instance: PRGitUtils | None = None,
remote_name: str = "origin",
include_remote: bool = True,
include_local: bool = True,
) -> bool
Check if a branch exists using pygit2.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
branch_name
|
str
|
Name of the branch to check (e.g., "main", "feature/foo"). |
required |
pgu_instance
|
PRGitUtils | None
|
Optional instance of PRGitUtils. If None, one will be created. |
None
|
remote_name
|
str
|
The name of the remote to check (default: "origin"). |
'origin'
|
include_remote
|
bool
|
Whether to check remote branches. |
True
|
include_local
|
bool
|
Whether to check local branches. |
True
|
Returns:
Type | Description |
---|---|
bool
|
True if the branch exists in the specified locations, False otherwise. |
Source code in src/codemap/git/pr_generator/strategies.py
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 |
|
get_default_branch
get_default_branch(
pgu_instance: PRGitUtils | None = None,
) -> str
Get the default branch of the repository using pygit2.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pgu_instance
|
PRGitUtils | None
|
Optional instance of PRGitUtils. |
None
|
Returns:
Type | Description |
---|---|
str
|
Name of the default branch (e.g., "main", "master"). |
Source code in src/codemap/git/pr_generator/strategies.py
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 |
|