----------------------------------------------------------------------
This is the API documentation for the gdtest_config_combo_c library.
----------------------------------------------------------------------


## Build Pipeline

Build and deployment functions


build(target: str = 'all') -> dict

Build the project for the specified target.

Parameters
----------
target : str, optional
    The build target, by default "all".

Returns
-------
dict
    A dictionary containing the build status and artifacts.

Examples
--------
>>> build("docs")
{'status': 'success', 'target': 'docs'}

deploy(environment: str, dry_run: bool = False) -> str

Deploy the project to the specified environment.

Parameters
----------
environment : str
    The target environment (e.g., "staging", "production").
dry_run : bool, optional
    If True, simulate the deployment without making changes,
    by default False.

Returns
-------
str
    A message indicating the deployment result.

Examples
--------
>>> deploy("staging", dry_run=True)
'Dry run: would deploy to staging'


## Operations

Testing and monitoring functions


test(suite: str = 'unit') -> dict

Run the specified test suite.

Parameters
----------
suite : str, optional
    The name of the test suite to run, by default "unit".

Returns
-------
dict
    A dictionary containing test results with passed and
    failed counts.

Examples
--------
>>> test("integration")
{'suite': 'integration', 'passed': 10, 'failed': 0}

monitor(service: str, interval: int = 60) -> dict

Monitor a service at the given interval.

Parameters
----------
service : str
    The name of the service to monitor.
interval : int, optional
    The monitoring interval in seconds, by default 60.

Returns
-------
dict
    A dictionary containing the service status and uptime.

Examples
--------
>>> monitor("api", interval=30)
{'service': 'api', 'status': 'healthy', 'interval': 30}