|
| 1 | +```mermaid |
| 2 | +graph LR |
| 3 | + Execution_Dispatcher["Execution Dispatcher"] |
| 4 | + Analysis_Strategy_Manager["Analysis Strategy Manager"] |
| 5 | + Quality_Environment_Guard["Quality & Environment Guard"] |
| 6 | + Execution_Dispatcher -- "invokes to execute analysis phase" --> Analysis_Strategy_Manager |
| 7 | + Execution_Dispatcher -- "triggers validation and health reporting" --> Quality_Environment_Guard |
| 8 | + Analysis_Strategy_Manager -- "utilizes drift detection for baseline validation" --> Quality_Environment_Guard |
| 9 | + Quality_Environment_Guard -- "provides health metrics for metadata finalization" --> Analysis_Strategy_Manager |
| 10 | +``` |
| 11 | + |
| 12 | +[](https://github.com/CodeBoarding/CodeBoarding)[](https://www.codeboarding.org/diagrams)[](mailto:contact@codeboarding.org) |
| 13 | + |
| 14 | +## Details |
| 15 | + |
| 16 | +Acts as the central controller for the action. It validates the environment, manages the transition between full codebase scans and incremental PR analysis, and ensures metadata consistency across runs. |
| 17 | + |
| 18 | +### Execution Dispatcher |
| 19 | +Acts as the primary entry point and high-level coordinator. It sequences the execution phases (seed, analyze, render, health) and manages the global execution context for the GitHub Action. |
| 20 | + |
| 21 | + |
| 22 | +**Related Classes/Methods**: |
| 23 | + |
| 24 | +- `scripts.engine_adapter.main`:488-558 |
| 25 | +- `scripts.engine_adapter.run_head`:303-324 |
| 26 | +- `scripts.engine_adapter.run_render`:397-410 |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +**Source Files:** |
| 31 | + |
| 32 | +- [`scripts/engine_adapter.py`](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py) |
| 33 | + - `scripts.engine_adapter.run_seed` ([L222-L249](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L222-L249)) - Function |
| 34 | + - `scripts.engine_adapter.run_head` ([L303-L324](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L303-L324)) - Function |
| 35 | + - `scripts.engine_adapter.run_render` ([L397-L410](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L397-L410)) - Function |
| 36 | + - `scripts.engine_adapter.run_concat` ([L413-L426](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L413-L426)) - Function |
| 37 | + - `scripts.engine_adapter.main` ([L488-L558](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L488-L558)) - Function |
| 38 | + |
| 39 | + |
| 40 | +### Analysis Strategy Manager |
| 41 | +Determines the optimal analysis mode (Full vs. Incremental) based on the Git context and manages the persistence of analysis metadata to ensure continuity between PR updates. |
| 42 | + |
| 43 | + |
| 44 | +**Related Classes/Methods**: |
| 45 | + |
| 46 | +- `scripts.engine_adapter.run_analyze`:327-394 |
| 47 | +- `scripts.engine_adapter._incremental_or_full`:252-300 |
| 48 | +- `scripts.engine_adapter._load_metadata`:77-87 |
| 49 | +- `scripts.engine_adapter._metadata_commit`:97-99 |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +**Source Files:** |
| 54 | + |
| 55 | +- [`scripts/engine_adapter.py`](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py) |
| 56 | + - `scripts.engine_adapter._log_path` ([L64-L65](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L64-L65)) - Function |
| 57 | + - `scripts.engine_adapter._clear_dir` ([L68-L74](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L68-L74)) - Function |
| 58 | + - `scripts.engine_adapter._load_metadata` ([L77-L87](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L77-L87)) - Function |
| 59 | + - `scripts.engine_adapter._metadata_commit` ([L97-L99](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L97-L99)) - Function |
| 60 | + - `scripts.engine_adapter.baseline_info` ([L102-L112](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L102-L112)) - Function |
| 61 | + - `scripts.engine_adapter.run_base` ([L207-L219](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L207-L219)) - Function |
| 62 | + - `scripts.engine_adapter._incremental_or_full` ([L252-L300](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L252-L300)) - Function |
| 63 | + - `scripts.engine_adapter.run_analyze` ([L327-L394](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L327-L394)) - Function |
| 64 | + - `scripts.engine_adapter.run_analyze.full` ([L343-L359](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L343-L359)) - Function |
| 65 | + |
| 66 | + |
| 67 | +### Quality & Environment Guard |
| 68 | +Validates the integrity of the analysis environment before execution and performs post-analysis health checks to report on the quality and coverage of the generated insights. |
| 69 | + |
| 70 | + |
| 71 | +**Related Classes/Methods**: |
| 72 | + |
| 73 | +- `scripts.engine_adapter.validate_base_analysis`:149-204 |
| 74 | +- `scripts.engine_adapter.run_health`:456-485 |
| 75 | +- `scripts.engine_adapter._docs_only_baseline_drift`:115-146 |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | +**Source Files:** |
| 80 | + |
| 81 | +- [`scripts/engine_adapter.py`](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py) |
| 82 | + - `scripts.engine_adapter._metadata_depth` ([L90-L94](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L90-L94)) - Function |
| 83 | + - `scripts.engine_adapter._docs_only_baseline_drift` ([L115-L146](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L115-L146)) - Function |
| 84 | + - `scripts.engine_adapter._docs_only_baseline_drift.git` ([L118-L125](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L118-L125)) - Function |
| 85 | + - `scripts.engine_adapter.validate_base_analysis` ([L149-L204](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L149-L204)) - Function |
| 86 | + - `scripts.engine_adapter._count_report_issues` ([L429-L442](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L429-L442)) - Function |
| 87 | + - `scripts.engine_adapter._count_health_report` ([L445-L453](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L445-L453)) - Function |
| 88 | + - `scripts.engine_adapter.run_health` ([L456-L485](https://github.com/CodeBoarding/CodeBoarding-action/blob/main/.codeboardingscripts/engine_adapter.py#L456-L485)) - Function |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) |
0 commit comments