chore: update demo to the latest cookiecutter-robust-python

Author: 56kyle

.cookiecutter.json

@@ -1,5 +1,5 @@
 {
-  "_commit": "dab1f8da6cb6be90a50db1aafb4411ec61fbcb2c",
+  "_commit": "34a57b81ff4263362669776636b30a8d051687a3",
   "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
   "add_rust_extension": false,
   "author": "Kyle Oliver",

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
-  "commit": "dab1f8da6cb6be90a50db1aafb4411ec61fbcb2c",
+  "commit": "34a57b81ff4263362669776636b30a8d051687a3",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -18,7 +18,7 @@
       "license": "MIT",
       "development_status": "Development Status :: 1 - Planning",
       "_template": "C:\\Users\\56kyl\\source\\repos\\cookiecutter-robust-python",
-      "_commit": "dab1f8da6cb6be90a50db1aafb4411ec61fbcb2c"
+      "_commit": "34a57b81ff4263362669776636b30a8d051687a3"
     }
   },
   "directory": null

.github/workflows/bump-version.yml

@@ -3,8 +3,7 @@ name: Bump version
 on:
   push:
     branches:
-      - master
-      - main
+      - "release/*"
 
 jobs:
   bump-version:
@@ -15,17 +14,9 @@ jobs:
       - name: Check out
         uses: actions/checkout@v4
         with:
-          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
           fetch-depth: 0
       - name: Create bump and changelog
         uses: commitizen-tools/commitizen-action@master
         with:
-          github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-          changelog_increment_filename: body.md
-      - name: Release
-        uses: softprops/action-gh-release@v1
-        with:
-          body_path: "body.md"
-          tag_name: ${{ env.REVISION }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-github.yml

@@ -0,0 +1,24 @@
+name: release-github.yml
+on:
+
+
+jobs:
+  generate-release-notes:
+    if: "startsWith(github.event.head_commit.message, 'bump:')"
+    runs-on: ubuntu-latest
+    name: "Generate Release Notes"
+    steps:
+      - name: Create Release Notes
+        uses: commitizen-tools/commitizen-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          changelog: "false"
+          dry_run: "true"
+          changelog_increment_filename: body.md
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: "body.md"
+          tag_name: ${{ env.REVISION }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-python.yml

@@ -109,6 +109,16 @@ jobs:
         id: get_tag
         run: echo "tag=${{ github.ref_name }}" >> $GITHUB_OUTPUT
 
+      - name: Generate Release Notes
+        run: |
+          if [ -z "${{ steps.previous_tag.outputs.previous }}" ]; then
+            echo "No previous tag found: generating changelog for all commits."
+            cz changelog --dry-run > RELEASE_NOTES.md
+          else
+            echo "Previous tag found: generating changelog diff."
+            cz changelog --dry-run --rev-range ${{ steps.previous_tag.outputs.previous }}..${GITHUB_REF_NAME} > RELEASE_NOTES.md
+          fi
+
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:

noxfile.py

@@ -193,15 +193,15 @@ def build_container(session: Session) -> None:
     session.log(f"Container image {project_image_name}:latest built locally.")
 
 
-@nox.session(python=None, name="prepare-release", tags=[RELEASE])
-def prepare_release(session: Session) -> None:
+@nox.session(python=None, name="seutp-release", tags=[RELEASE])
+def setup_release(session: Session) -> None:
     """Prepares a release by creating a release branch and bumping the version.
 
-    Does not commit or push the release branch. Additionally, does not tag the release.
+    Additionally, creates the initial bump commit but doesn't push it.
     """
-    session.log("Preparing release...")
+    session.log("Setting up release...")
 
-    session.run("python", SCRIPTS_FOLDER / "prepare-release.py", external=True)
+    session.run("python", SCRIPTS_FOLDER / "setup-release.py", external=True)
 
 
 @nox.session(python=None, tags=[RELEASE])

scripts/bump-version.py

@@ -0,0 +1,30 @@
+"""Script responsible for bumping the version of the robust-python-demo package."""
+
+import argparse
+
+from util import bump_version
+
+
+def main() -> None:
+    """Parses args and passes through to bump_version."""
+    parser: argparse.ArgumentParser = get_parser()
+    args: argparse.Namespace = parser.parse_args()
+    bump_version(increment=args.increment)
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """Creates the argument parser for prepare-release."""
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(
+        prog="bump-version", usage="python ./scripts/bump-version.py patch"
+    )
+    parser.add_argument(
+        "increment",
+        type=str,
+        help="Increment type to use when preparing the release.",
+        choices=["MAJOR", "MINOR", "PATCH", "PRERELEASE"],
+    )
+    return parser
+
+
+if __name__ == "__main__":
+    main()

scripts/prepare-release.py renamed to scripts/setup-release.py

@@ -1,31 +1,22 @@
 """Script responsible for preparing a release of the robust-python-demo package."""
 
 import argparse
-import re
-import shutil
 import subprocess
-from pathlib import Path
-from re import Match
-from typing import Literal
 from typing import Optional
-from typing import Pattern
-from typing import TypeAlias
-
 
+from util import bump_version
 from util import check_dependencies
-from util import remove_readonly
+from util import create_release_branch
+from util import get_package_version
+from util import get_bumped_package_version
 from util import REPO_FOLDER
 
 
-Increment: TypeAlias = Literal["major", "minor", "patch", "prerelease"]
-CZ_PATTERN: Pattern[str] = re.compile(r"bump: version (?P<current_version>.*?) → (?P<new_version>.*?)")
-
-
 def main() -> None:
-    """Parses args and passes through to prepare_release."""
+    """Parses args and passes through to setup_release."""
     parser: argparse.ArgumentParser = get_parser()
     args: argparse.Namespace = parser.parse_args()
-    prepare_release(path=args.path, python_version=args.python_version)
+    setup_release(increment=args.increment)
 
 
 def get_parser() -> argparse.ArgumentParser:
@@ -42,39 +33,27 @@ def get_parser() -> argparse.ArgumentParser:
     return parser
 
 
-def prepare_release(increment: Optional[str] = None) -> None:
+def setup_release(increment: Optional[str] = None) -> None:
     """Prepares a release of the robust-python-demo package.
 
     Sets up a release branch from the branch develop, bumps the version, and creates a release commit. Does not tag the
     release or push any changes.
     """
-    dry_run_cmd: list[str] = ["uvx", "cz", "bump", "--dry-run", "--yes"]
-    bump_cmd: list[str] = ["uvx", "cz", "bump", "--yes", "--files-only", "--changelog"]
-    if increment is not None:
-        dry_run_cmd.extend(["--increment", increment])
-        bump_cmd.extend(["--increment", increment])
+    check_dependencies(path=REPO_FOLDER, dependencies=["git", "cz"])
 
-    result: subprocess.CompletedProcess = subprocess.run(dry_run_cmd, cwd=REPO_FOLDER, capture_output=True)
-    match: Match = re.match(CZ_PATTERN, result.stdout)
-    current_version: str = match.group("current_version")
-    new_version: str = match.group("new_version")
+    current_version: str = get_package_version()
+    new_version: str = get_bumped_package_version(increment=increment)
+    create_release_branch(new_version=new_version)
+    bump_version(increment=increment)
 
     commands: list[list[str]] = [
-        ["git", "status", "--porcelain"],
-        ["git", "branch", "-b", f"release/{new_version}", "develop"],
-        ["git", "checkout", f"release/{new_version}"],
-        bump_cmd,
         ["git", "add", "."],
         ["git", "commit", "-m", f"bump: version {current_version} → {new_version}"]
     ]
 
-    check_dependencies(path=REPO_FOLDER, dependencies=["git", "cz"])
-
     for command in commands:
         subprocess.run(command, cwd=REPO_FOLDER, capture_output=True, check=True)
 
 
 if __name__ == "__main__":
     main()
-
-

scripts/util.py

@@ -6,10 +6,15 @@
 from pathlib import Path
 from typing import Any
 from typing import Callable
+from typing import Literal
+from typing import Optional
+from typing import TypeAlias
 
 
 REPO_FOLDER: Path = Path(__file__).resolve().parent.parent
 
+Increment: TypeAlias = Literal["MAJOR", "MINOR", "PATCH", "PRERELEASE"]
+
 
 class MissingDependencyError(Exception):
     """Exception raised when a depedency is missing from the system running setup-repo."""
@@ -52,3 +57,83 @@ def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
     """
     Path(path).chmod(stat.S_IWRITE)
     func(path)
+
+
+def get_package_version() -> str:
+    """Gets the package version."""
+    result: subprocess.CompletedProcess = subprocess.run(
+        ["uvx", "version", "-p"],
+        cwd=REPO_FOLDER,
+        capture_output=True
+    )
+    return result.stdout.decode("utf-8").strip()
+
+
+def get_bumped_package_version(increment: Optional[Increment] = None) -> str:
+    """Gets the bumped package version."""
+    args: list[str] = ["uvx", "cz", "bump", "--get-next", "--yes", "--dry-run"]
+    if increment is not None:
+        args.extend(["--increment", increment])
+    result: subprocess.CompletedProcess = subprocess.run(args, cwd=REPO_FOLDER, capture_output=True)
+    return result.stdout.decode("utf-8").strip()
+
+
+def create_release_branch(new_version: str) -> None:
+    """Creates a release branch."""
+    commands: list[list[str]] = [
+        ["git", "status", "--porcelain"],
+        ["git", "branch", "-b", f"release/{new_version}", "develop"],
+        ["git", "checkout", f"release/{new_version}"],
+    ]
+    for command in commands:
+        subprocess.run(command, cwd=REPO_FOLDER, capture_output=True, check=True)
+
+
+def bump_version(increment: Optional[Increment] = None) -> None:
+    """Bumps the package version."""
+    bump_cmd: list[str] = ["uvx", "cz", "bump", "--yes", "--files-only", "--changelog"]
+    if increment is not None:
+        bump_cmd.extend(["--increment", increment])
+    subprocess.run(bump_cmd, cwd=REPO_FOLDER, check=True)
+
+
+def get_latest_tag() -> Optional[str]:
+    """Gets the latest git tag."""
+    sort_tags: list[str] = ["git", "tag", "--sort=-creatordate"]
+    find_last: list[str] = ["grep", "-v", '"${GITHUB_REF_NAME}"']
+    echo_none: list[str] = ["echo", "''"]
+    result: subprocess.CompletedProcess = subprocess.run(
+        [*sort_tags, "|", *find_last, "|", "tail", "-n1", "||", *echo_none],
+        cwd=REPO_FOLDER,
+        capture_output=True
+    )
+    tag: str = result.stdout.decode("utf-8").strip()
+    if tag == "":
+        return None
+    return tag
+
+
+def get_latest_release_notes() -> None:
+    """Gets the release notes.
+
+    Assumes the latest_tag hasn't been applied yet.
+    """
+    latest_tag: Optional[str] = get_latest_tag()
+    latest_version: str = get_package_version()
+    if latest_tag == latest_version:
+        raise ValueError(
+            "The latest tag and version are the same. Please ensure the release notes are taken before tagging."
+        )
+    rev_range: str = latest_version if latest_tag is None else f"{latest_tag}..{latest_version}"
+
+    result: subprocess.CompletedProcess = subprocess.run(
+        ["uvx", "cz", "changelog", rev_range, "--dry-run"],
+        cwd=REPO_FOLDER,
+        check=True
+    )
+    return result.stdout.decode("utf-8")
+
+
+def tag_release() -> None:
+    """Tags the release using commitizen bump with tag only."""
+    subprocess.run(["uvx", "cz", "bump", "--tag-only", "--yes"], cwd=REPO_FOLDER, check=True)