main.py

# Copyright 2024 ABSA Group Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

"""
This module contains the main script for the Living Documentation Generator GH Action.
It sets up logging, loads action inputs, generates the documentation and sets the output
for the GH Action.
"""

import logging
import sys

from action_inputs import ActionInputs
from living_documentation_regime.living_documentation_generator import LivingDocumentationGenerator
from utils.constants import OUTPUT_PATH
from utils.github_project_queries import validate_query_formats
from utils.utils import set_action_output, make_absolute_path
from utils.logging_config import setup_logging


def run() -> None:
    """
    The main function to run the Living Documentation Generator.

    @return: None
    """
    setup_logging()
    logger = logging.getLogger(__name__)

    logger.info("Living Documentation generator - starting.")

    if not ActionInputs().validate_user_configuration():
        logger.info("Living Documentation generator - user configuration validation failed.")
        sys.exit(1)

    if not validate_query_formats():
        logger.info("Living Documentation generator - query format validation failed.")
        sys.exit(1)

    output_path: str = make_absolute_path(OUTPUT_PATH)
    all_regimes_success: bool = True

    if ActionInputs.is_living_doc_regime_enabled():
        logger.info("Living Documentation generator - Starting the `LivDoc` generation regime.")

        # Generate the Living documentation
        if LivingDocumentationGenerator(output_path).generate():
            logger.info("Living Documentation generator - `LivDoc` generation regime completed successfully.")
        else:
            logger.info("Living Documentation generator - `LivDoc` generation regime failed.")
            all_regimes_success = False
    else:
        logger.info("Living Documentation generator - `LivDoc` generation regime disabled.")

    # elif ActionInputs.get_ci_regime():
    #     logger.info("Living Documentation generator - Starting the `CI` generation regime.")
    #
    #     # Generate the CI Documentation
    #     CiDocumentationGenerator().generate()
    #
    #     logger.info("Living Documentation generator - `CI` generation regime completed.")

    # Set the output for the GitHub Action
    set_action_output("output-path", output_path)
    logger.info("Living Documentation generator - root output path set to `%s`.", output_path)

    logger.info("Living Documentation generator - ending.")

    if not all_regimes_success:
        sys.exit(1)


if __name__ == "__main__":
    run()