Function pre_release

scripts/release.py:102–119

Generates new docs, release announcements and creates a local tag.

(
    version: str, template_name: str, doc_version: str, *, skip_check_links: bool
)

def pre_release(
    version: str, template_name: str, doc_version: str, *, skip_check_links: bool
) -> None:
    class="st">""class="st">"Generates new docs, release announcements and creates a local tag."class="st">""
    announce(version, template_name, doc_version)
    regen(version)
    changelog(version, write_out=True)
    fix_formatting()
    if not skip_check_links:
        check_links()

    msg = fclass="st">"Prepare release version {version}"
    check_call([class="st">"git", class="st">"commit", class="st">"-a", class="st">"-m", msg])

    print()
    print(fclass="st">"{Fore.CYAN}[generate.pre_release] {Fore.GREEN}All done!")
    print()
    print(class="st">"Please push your branch and open a PR.")


def changelog(version: str, write_out: bool = False) -> None: