tasks.py

"""Tasks for use with Invoke.
(c) 2022 Network To Code
"""

import yaml
from pathlib import Path

from invoke import task


@task
def update_docs(context, local=False):
    """Run helm-docs to update README.md and reference.md.

    Mimics the Update Docs CI job without committing. By default runs
    via Docker from development/; set local=True to run helm-docs
    locally (must be installed).
    """
    if not local:
        print("Running helm-docs via Docker...")
        context.run(
            "docker compose -f development/docker-compose.yml run --build --rm update-docs",
            pty=True,
        )
    else:
        print("Running helm-docs locally...")
        context.run("helm-docs --chart-search-root=charts --template-files=README.md.gotmpl")
        context.run(
            "helm-docs --chart-to-generate=charts/nautobot "
            "--template-files=./docs/configuration/reference.md.gotmpl "
            "--output-file=../../docs/configuration/reference.md"
        )
    print("Docs updated.")


@task
def docs(context, strict=False):
    """Build and serve docs locally for development."""
    command = "poetry run mkdocs serve --verbose"
    if strict:
        command = f"{command} --strict"
    print("Serving Documentation...")
    context.run(command)


@task
def check_release_tag(context, tag):
    """Check that the provided tag matches the value in Chart.yaml."""

    print(f"Checking that provided tag '{tag}' matches Chart.yaml version.")

    if tag.startswith("v"):
        tag = tag[1:]
        print(f"Stripped leading 'v' from tag. New tag is '{tag}'.")

    print("Loading Chart.yaml.")
    chart_yaml_path = Path("charts/nautobot/Chart.yaml")
    with open(chart_yaml_path, "r", encoding="utf-8") as chart_file:
        chart_yaml_data = yaml.safe_load(chart_file)
        version = chart_yaml_data.get("version")
        print(f"Found version '{version}' in Chart.yaml.")

    if tag != version:
        print(f"ERROR: Provided tag '{tag}' does not match Chart.yaml version '{version}'.")
        exit(1)

    print(f"Provided tag '{tag}' matches Chart.yaml version '{version}'.")