Function create_release_index

Documentation/docs/vtk_documentation.py:298–370

Populate basedir with release files X.Y.md with X,Y being the major and minor versions respectively. it returns a string holding the toctree of the index file to be injected in basedir/index.md

(basedir)

def create_release_index(basedir):
    """Populate basedir with release files X.Y.md with X,Y being the major and minor versions respectively.
    it returns a string holding the toctree of the index file to be injected in basedir/index.md
    """
    # get x.y.0 releases skipping rc's
    command = r"git tag --sort=version:refname  --format '%(refname:strip=2) %(creatordate:format:%Y-%m-%d)'  | grep -v 'rc' | grep 'v[0-9]*\.[0-9]*\.0'"
    result = subprocess.run(command, shell=True, capture_output=True, text=True)
    tags = str(result.stdout).split("\n")[:-1]  # drop last empty line
    tags = tags[4:]  # skip release for which we do not have release notes
    files = []
    for entry in tags:
        tag, date = entry.split(" ")
        short_tag = tag[1:]  # strip 'v'
        short_tag = short_tag.rsplit(".", 1)[0]  #  drop last '.0'
        if tag in HISTORICAL_RELEASE_URLS:
            content = CONTENT_TEMPLATE.format(
                version=short_tag, url=HISTORICAL_RELEASE_URLS[tag], date=date
            )
            files.append(f"{short_tag}.md")
            create_release_file(
                path=os.path.join(basedir, f"{short_tag}.md"), content=content
            )
        else:  # look for release note markdown
            release_file_path = f"../release/{short_tag}.md"
            if os.path.exists(release_file_path):
                stripped_release_path = os.path.join("../release", f"_{short_tag}-stripped.md")
                write_stripped_release_file(release_file_path, stripped_release_path)
                with open(stripped_release_path, "r") as release_file:
                    release_file_content = release_file.read()
                author_notes = []
                short_tag_dir = f"../release/{short_tag}"
                if os.path.exists(short_tag_dir):
                    for (dirpath, dirname, filenames) in os.walk(short_tag_dir):
                        dest_short_tag_dir = f"{basedir}/{short_tag}/"
                        if not os.path.exists(dest_short_tag_dir):
                            os.makedirs(dest_short_tag_dir)
                        for fn in filenames:
                            # Copy the note file if is referenced from included "{short_tag}.md"
                            full_fn = f"{short_tag}/{fn}"
                            if full_fn in release_file_content:
                                src = os.path.join("../release", full_fn)
                                dst = os.path.join(dest_short_tag_dir, fn)
                                shutil.copy(src, dst)
                                author_notes.append(full_fn.removesuffix(".md"))
                                with open(src, "r") as note_file:
                                    note_content = note_file.read()
                                for img_version, img_file in extract_image_links(note_content):
                                    src_img = os.path.join("../release/imgs", img_version, img_file)
                                    dst_img_dir = os.path.join("release_details/imgs", img_version)
                                    os.makedirs(dst_img_dir, exist_ok=True)
                                    shutil.copy(src_img, os.path.join(dst_img_dir, img_file))
                            else:
                                print(f"Warning: '{short_tag}/{fn}' is not referenced from '{release_file_path}'")
                content = CONTENT_TEMPLATE2.format(version=short_tag, date=date, author_notes="\n".join(sorted(author_notes)).strip())
                create_release_file(
                    path=os.path.join(basedir, f"{short_tag}.md"), content=content
                )
                files.append(f"{short_tag}.md")