nerfstudio/scripts/debugging/run_actions.py

"""Simple yaml debugger"""
import subprocess
import sys

import dcargs
import yaml

LOCAL_TESTS = ["Run license checks", "Run isort", "Run Black", "Python Pylint", "Test with pytest"]


def run_command(command: str, continue_on_fail: bool = False) -> None:
    """Run a command kill actions if it fails

    Args:
        command: command to run
        continue_on_fail: whether to continue running commands if the current one fails. Defaults to False.
    """
    ret_code = subprocess.call(command, shell=True)
    if not continue_on_fail and ret_code != 0:
        print(f"\033[31mError: `{command}` failed. Exiting...\033[0m")
        sys.exit(1)


def main(continue_on_fail: bool = False):
    """Run the github actions locally.

    Args:
        continue_on_fail: Whether to continue running actions commands if the current one fails
    """
    with open(".github/workflows/code_checks.yml", "rb") as f:
        my_dict = yaml.safe_load(f)
    steps = my_dict["jobs"]["build"]["steps"]

    print_green = lambda x: print(f"\033[32m{x}\033[0m")

    for step in steps:
        if "name" in step and step["name"] in LOCAL_TESTS:
            compressed = step["run"].replace("\n", ";").replace("\\", "")
            compressed = compressed.replace("--check", "")
            curr_command = f"{compressed}"

            print("*" * 100)
            print_green(f"Running: {curr_command}")
            run_command(curr_command, continue_on_fail=continue_on_fail)
        else:
            print("*" * 100)
            print(f"Skipping {step}")

    # Add checks for building documentation
    print_green("Adding notebook documentation metadata")
    run_command("python scripts/docs/add_nb_tags.py")
    print_green("Building Documentation")
    run_command("cd docs/; make html SPHINXOPTS='-W;'")

    print("\n")
    print_green("=" * 100)
    print_green("ALL CHECKS PASSED")
    print_green("=" * 100)


if __name__ == "__main__":
    dcargs.cli(main)