From 8c1d7632dded4f221c61d942b548c1552f5b8292 Mon Sep 17 00:00:00 2001 From: Daniel Tomlinson Date: Tue, 23 Nov 2021 20:53:58 +0000 Subject: [PATCH] chore: update cliff.toml & duties.py --- cliff.toml | 2 +- duties.py | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/cliff.toml b/cliff.toml index 43a2eac..c956128 100644 --- a/cliff.toml +++ b/cliff.toml @@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 # https://tera.netlify.app/docs/#introduction body = """ {% if version %}\ - ## [{{ version | trim_start_matches(pat="v") }}](https://github.com/tembo-pages/tembo-core/commits/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + ## [{{ version }}](https://github.com/tembo-pages/tembo-core/commits/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} {% if previous.version %}\ [Compare with {{ previous.version }}](https://github.com/tembo-pages/tembo-core/compare/{{ previous.version }}...{{ version }}) {% endif %}\ diff --git a/duties.py b/duties.py index 3d4574a..581ad61 100644 --- a/duties.py +++ b/duties.py @@ -13,6 +13,7 @@ from urllib.request import urlopen from duty import duty PACKAGE_NAME = "tembo" +REPO_URL = "https://github.com/tembo-pages/tembo-core" @duty(post=["export"]) @@ -322,16 +323,25 @@ def check_dependencies(ctx): pty=True, ) + @duty -def changelog(ctx, planned_release: Optional[str] = None): +def changelog(ctx, planned_release: Optional[str] = None, previous_release: Optional[str] = None): """ Generate a changelog with git-cliff. Args: ctx: The context instance (passed automatically). planned_release (str, optional): The planned release version. Example: v1.0.2 + previous_release (str, optional): The previous release version. Example: v1.0.1 """ - generated_changelog = ctx.run(["git", "cliff", "-u", "-t", planned_release, "-s", "header"])[:-1] + generated_changelog: str = ctx.run(["git", "cliff", "-u", "-t", planned_release, "-s", "header"])[:-1] + if previous_release is not None: + generated_changelog: list = generated_changelog.splitlines() + generated_changelog.insert( + 1, + f"[Compare with {previous_release}]({REPO_URL}/compare/{previous_release}..{planned_release})", + ) + generated_changelog: str = "\n".join([line for line in generated_changelog]) + "\n" new_changelog = [] changelog_file = pathlib.Path(".") / "CHANGELOG.md"