tinysemver 2.1.0__tar.gz → 3.0.0__tar.gz

{tinysemver-2.1.0/tinysemver.egg-info → tinysemver-3.0.0}/PKG-INFO

@@ -1,8 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tinysemver
-Version: 2.1.0
-Summary: Semantic-Versioning with LLMs and without 300,000 lines of JS
-Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
+Version: 3.0.0
+Summary: Semantic-Versioning... that doesn't need 300,000 lines of JS
+Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
@@ -206,10 +206,10 @@ License:                                  Apache License
            limitations under the License.
         
 Project-URL: Homepage, https://pypi.org/project/tinysemver/
-Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main/README.md
-Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
-Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
-Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/ashvardanian/TinySemVer/blob/main/README.md
+Project-URL: Repository, https://github.com/ashvardanian/TinySemVer.git
+Project-URL: Issues, https://github.com/ashvardanian/TinySemVer/issues
+Project-URL: Changelog, https://github.com/ashvardanian/TinySemVer/blob/main/CHANGELOG.md
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
@@ -223,12 +223,23 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: openai>=1.54.4
 Requires-Dist: rich>=13.8.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Dynamic: license-file
 
 ![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -306,19 +317,6 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
-## AI and Rock-n-Roll
-
-TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
-
-```sh
-$ tinysemver --verbose \
-    --github-repository 'ashvardanian/tinysemver' \
-    --openai-base-url 'https://api.groq.com/openai/v1' \
-    --openai-api-key 'GET_YOURSELF_A_KEY' \
-    --openai-model 'llama-3.2-11b-text-preview' \
-    --dry-run
-```
-
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.
@@ -337,12 +335,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         persist-credentials: false # Only if main branch if protected
 
     - name: Run TinySemVer
-      uses: ashvardanian/tinysemver@v2.0.1
+      uses: ashvardanian/tinysemver@v3 # Automatically receives non-breaking updates
       with:
         major-verbs: 'breaking,break,major'
         minor-verbs: 'feature,minor,add,new'
@@ -363,7 +361,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: main # Take the most recent updated version
 ```
@@ -382,6 +380,30 @@ If you need to update the version in multiple files, pass a multiline string wit
 
 For examples, consider checking StringZilla, USearch, and other libraries using TinySemVer.
 
+Since version 3.0.0, TinySemVer can optionally maintain moving version tags similar to `actions/checkout@v4`:
+
+```yaml
+uses: ashvardanian/tinysemver@v3       # Automatically gets non-breaking updates
+uses: ashvardanian/tinysemver@v3.0     # Automatically gets patch updates
+uses: ashvardanian/tinysemver@v3.0.0   # Pinned, never changes
+uses: ashvardanian/tinysemver@main     # Bleeding edge
+```
+
+This feature is disabled by default because it requires force-push permissions.
+To enable it, add `push-moving-tags: 'true'` and ensure your token has force-push access:
+
+```yaml
+    - name: Run TinySemVer
+      uses: ashvardanian/tinysemver@v3
+      with:
+        push: 'true'
+        push-moving-tags: 'true'
+        github-token: ${{ secrets.TINYSEMVER_TOKEN }}
+```
+
+When enabled, TinySemVer creates three tags: `v3` (major), `v3.0` (minor), and `v3.0.0` (specific).
+The default `GITHUB_TOKEN` typically lacks force-push permissions for protected branches.
+
 ### Security Considerations
 
 If your default branch is protected with a "pull request before merging" rule:

{tinysemver-2.1.0 → tinysemver-3.0.0}/README.md

@@ -1,6 +1,6 @@
 ![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -78,19 +78,6 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
-## AI and Rock-n-Roll
-
-TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
-
-```sh
-$ tinysemver --verbose \
-    --github-repository 'ashvardanian/tinysemver' \
-    --openai-base-url 'https://api.groq.com/openai/v1' \
-    --openai-api-key 'GET_YOURSELF_A_KEY' \
-    --openai-model 'llama-3.2-11b-text-preview' \
-    --dry-run
-```
-
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.
@@ -109,12 +96,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         persist-credentials: false # Only if main branch if protected
 
     - name: Run TinySemVer
-      uses: ashvardanian/tinysemver@v2.0.1
+      uses: ashvardanian/tinysemver@v3 # Automatically receives non-breaking updates
       with:
         major-verbs: 'breaking,break,major'
         minor-verbs: 'feature,minor,add,new'
@@ -135,7 +122,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: main # Take the most recent updated version
 ```
@@ -154,6 +141,30 @@ If you need to update the version in multiple files, pass a multiline string wit
 
 For examples, consider checking StringZilla, USearch, and other libraries using TinySemVer.
 
+Since version 3.0.0, TinySemVer can optionally maintain moving version tags similar to `actions/checkout@v4`:
+
+```yaml
+uses: ashvardanian/tinysemver@v3       # Automatically gets non-breaking updates
+uses: ashvardanian/tinysemver@v3.0     # Automatically gets patch updates
+uses: ashvardanian/tinysemver@v3.0.0   # Pinned, never changes
+uses: ashvardanian/tinysemver@main     # Bleeding edge
+```
+
+This feature is disabled by default because it requires force-push permissions.
+To enable it, add `push-moving-tags: 'true'` and ensure your token has force-push access:
+
+```yaml
+    - name: Run TinySemVer
+      uses: ashvardanian/tinysemver@v3
+      with:
+        push: 'true'
+        push-moving-tags: 'true'
+        github-token: ${{ secrets.TINYSEMVER_TOKEN }}
+```
+
+When enabled, TinySemVer creates three tags: `v3` (major), `v3.0` (minor), and `v3.0.0` (specific).
+The default `GITHUB_TOKEN` typically lacks force-push permissions for protected branches.
+
 ### Security Considerations
 
 If your default branch is protected with a "pull request before merging" rule:

{tinysemver-2.1.0 → tinysemver-3.0.0}/pyproject.toml

@@ -4,13 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinysemver"
-version = "2.1.0"
-description = "Semantic-Versioning with LLMs and without 300,000 lines of JS"
+version = "3.0.0"
+description = "Semantic-Versioning... that doesn't need 300,000 lines of JS"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [
-    { name = "Ash Vardanian", email = "1983160+ashvardanian@users.noreply.github.com" },
-    { name = "Guillaume de Rouville", email = "31691250+grouville@users.noreply.github.com" },
+    { name = "Ash Vardanian", email = "1983160+ashvardanian@users.noreply.github.com" }
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -25,17 +24,32 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
 ]
-dependencies = ["openai >= 1.54.4", "rich >= 13.8.0"]
+dependencies = ["rich >= 13.8.0"]
+
+[project.optional-dependencies]
+test = [
+    "pytest >= 7.0.0",
+    "pytest-cov >= 4.0.0",
+    "pytest-mock >= 3.10.0",
+]
+dev = [
+    "pytest >= 7.0.0",
+    "pytest-cov >= 4.0.0",
+    "pytest-mock >= 3.10.0",
+    "ruff >= 0.1.0",
+    "mypy >= 1.0.0",
+    "black >= 23.0.0",
+]
 
 [project.scripts]
 tinysemver = "tinysemver.tinysemver:main"
 
 [project.urls]
 Homepage = "https://pypi.org/project/tinysemver/"
-Documentation = "https://github.com/ashvardanian/tinysemver/blob/main/README.md"
-Repository = "https://github.com/ashvardanian/tinysemver.git"
-Issues = "https://github.com/ashvardanian/tinysemver/issues"
-Changelog = "https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md"
+Documentation = "https://github.com/ashvardanian/TinySemVer/blob/main/README.md"
+Repository = "https://github.com/ashvardanian/TinySemVer.git"
+Issues = "https://github.com/ashvardanian/TinySemVer/issues"
+Changelog = "https://github.com/ashvardanian/TinySemVer/blob/main/CHANGELOG.md"
 
 [tool.setuptools]
 package-dir = { "" = "." }

tinysemver-3.0.0/tinysemver/__init__.py

@@ -0,0 +1,75 @@
+"""TinySemVer - A tiny but mighty Semantic Versioning tool.
+
+This package provides automated semantic versioning for Git repositories
+following Conventional Commits. It can generate changelogs and release notes
+with or without LLM assistance.
+
+Example:
+    >>> from tinysemver import bump
+    >>> new_version = bump(
+    ...     path=".",
+    ...     dry_run=True,
+    ...     verbose=True,
+    ...     version_file="VERSION",
+    ...     changelog_file="CHANGELOG.md"
+    ... )
+"""
+
+from tinysemver.tinysemver import (
+    # Main function
+    bump,
+    # Version utilities
+    parse_version,
+    bump_version,
+    # Commit utilities
+    commit_starts_with_verb,
+    normalize_verbs,
+    group_commits,
+    convert_commits_to_message,
+    # Git utilities
+    get_last_tag,
+    get_commits_since_tag,
+    get_diff_for_commit,
+    # File utilities
+    patch_with_regex,
+    # Tag creation
+    create_tag,
+    # Types
+    SemVer,
+    BumpType,
+    PathLike,
+    Commit,
+    ChangeDiff,
+    # Exceptions
+    NoNewCommitsError,
+)
+
+__version__ = "2.1.1"
+__all__ = [
+    # Main function
+    "bump",
+    # Version utilities
+    "parse_version",
+    "bump_version",
+    # Commit utilities
+    "commit_starts_with_verb",
+    "normalize_verbs",
+    "group_commits",
+    "convert_commits_to_message",
+    # Git utilities
+    "get_last_tag",
+    "get_commits_since_tag",
+    "get_diff_for_commit",
+    # File utilities
+    "patch_with_regex",
+    # Tag creation
+    "create_tag",
+    # Types
+    "SemVer",
+    "BumpType",
+    "PathLike",
+    "Commit",
+    "ChangeDiff",
+    # Exceptions
+    "NoNewCommitsError",
+]

{tinysemver-2.1.0 → tinysemver-3.0.0}/tinysemver/tinysemver.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""TinySemVer is a tiny but mighty Semantic Versioning tool with AI, Drugs, and Rock-n-Roll.
+"""TinySemVer is a tiny minimalistic Semantic Versioning tool.
 
 This module traces the commit history of a Git repository after the last tag, and based 
 on the commit messages, it determines the type of version bump (major, minor, or patch).
@@ -15,7 +15,7 @@ Example:
         --minor-verbs 'feature,minor,add,new' \
         --patch-verbs 'fix,patch,bug,improve,docs,make' \
         --changelog-file 'CHANGELOG.md' \
-        --guide-file 'CONTIBUTING.md' \
+        --guide-file 'CONTRIBUTING.md' \
         --version-file 'VERSION' \
         --update-version-in 'package.json' '"version": "(.*)"' \
         --update-version-in 'CITATION.cff' '^version: (.*)' \
@@ -67,39 +67,10 @@ class NoNewCommitsError(Exception):
     pass
 
 
-class MayContainVulnerability(Warning):
-    """Raised when the commit may contain a vulnerability."""
-
-    pass
-
-
-class MayContainLogicalBugs(Warning):
-    """Raised when the commit may contain logical bugs."""
-
-    pass
-
-
-class MayContainBreakingChange(Warning):
-    """Raised when the commit may contain a breaking change."""
-
-    pass
-
-
-class MayLackDocumentation(Warning):
-    """Raised when the commit may lack documentation updates."""
-
-    pass
-
-
-class UnknownCommitWarning(Warning):
-    """Something in the commit doesn't add up."""
-
-    pass
 
 
 _console = None  # Initialize global console variable
 _console_is_rich = True  # Initialize global console type variable
-_openai_client = None  # Initialize global OpenAI client variable
 
 
 def print_to_console(message: str) -> None:
@@ -120,16 +91,6 @@ def print_to_console(message: str) -> None:
         print(message)
 
 
-def get_open_ai_client(base_url: str, api_key: str):
-    # Create a global variable for the client
-    global _openai_client
-    if not _openai_client:
-        from openai import OpenAI
-
-        _openai_client = OpenAI(base_url=base_url, api_key=api_key)
-    return _openai_client
-
-
 def get_last_tag(repository_path: PathLike) -> str:
     """Retrieve the last Git tag name from the repository."""
     result = subprocess.run(
@@ -262,6 +223,7 @@ def create_tag(
     github_repository: Optional[str] = None,
     push: bool = False,
     create_release: bool = False,
+    push_moving_tags: bool = False,
     major_commits: List[Commit] = None,
     minor_commits: List[Commit] = None,
     patch_commits: List[Commit] = None,
@@ -274,7 +236,8 @@ def create_tag(
     env["GIT_COMMITTER_EMAIL"] = user_email
     env["GIT_AUTHOR_NAME"] = user_name
     env["GIT_AUTHOR_EMAIL"] = user_email
-    env["GITHUB_TOKEN"] = github_token
+    if github_token:
+        env["GITHUB_TOKEN"] = github_token
 
     message = f"Release: {tag} [skip ci]"
     message += convert_commits_to_message(major_commits or [], minor_commits or [], patch_commits or [])
@@ -293,6 +256,29 @@ def create_tag(
 
     subprocess.run(["git", "tag", "-a", tag, "-m", message, new_commit_sha], cwd=repository_path, env=env)
     print_to_console(f"[bold green]Created new tag:[/bold green] {tag}")
+
+    # Optionally create moving major and minor version tags for GitHub Actions compatibility
+    # This allows users to reference @v2 or @v2.1 instead of @v2.1.1
+    # Note: This requires force-push permissions
+    if push_moving_tags:
+        major_tag = f"v{version[0]}"
+        minor_tag = f"v{version[0]}.{version[1]}"
+
+        # Force-update major version tag (e.g., v2 -> v2.1.1)
+        subprocess.run(
+            ["git", "tag", "-fa", major_tag, "-m", f"Update {major_tag} to {tag}", new_commit_sha],
+            cwd=repository_path,
+            env=env,
+        )
+        print_to_console(f"[bold green]Updated major version tag:[/bold green] {major_tag} -> {tag}")
+
+        # Force-update minor version tag (e.g., v2.1 -> v2.1.1)
+        subprocess.run(
+            ["git", "tag", "-fa", minor_tag, "-m", f"Update {minor_tag} to {tag}", new_commit_sha],
+            cwd=repository_path,
+            env=env,
+        )
+        print_to_console(f"[bold green]Updated minor version tag:[/bold green] {minor_tag} -> {tag}")
     if push:
         url = None
         if github_token and github_repository:
@@ -315,12 +301,41 @@ def create_tag(
                 f"Failed to push the new commits to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
             )
 
-        push_result = subprocess.run(["git", "push", url, "--tag"], cwd=repository_path, capture_output=True, env=env)
+        # Push the specific version tag (e.g., v2.1.1)
+        push_result = subprocess.run(["git", "push", url, tag], cwd=repository_path, capture_output=True, env=env)
         if push_result.returncode != 0:
             raise RuntimeError(
-                f"Failed to push the new tag to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
+                f"Failed to push the tag '{tag}' to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
+            )
+
+        print_to_console(f"[bold green]Pushed tag:[/bold green] {tag}")
+
+        # Optionally force-push the moving major and minor version tags
+        if push_moving_tags:
+            major_tag = f"v{version[0]}"
+            minor_tag = f"v{version[0]}.{version[1]}"
+
+            # Force-push the major version tag (e.g., v2)
+            push_result = subprocess.run(
+                ["git", "push", url, major_tag, "--force"], cwd=repository_path, capture_output=True, env=env
+            )
+            if push_result.returncode != 0:
+                raise RuntimeError(
+                    f"Failed to push major tag '{major_tag}' to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
+                )
+
+            # Force-push the minor version tag (e.g., v2.1)
+            push_result = subprocess.run(
+                ["git", "push", url, minor_tag, "--force"], cwd=repository_path, capture_output=True, env=env
             )
-        print_to_console(f"[bold green]Pushed to:[/bold green] {url}")
+            if push_result.returncode != 0:
+                raise RuntimeError(
+                    f"Failed to push minor tag '{minor_tag}' to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
+                )
+
+            print_to_console(f"[bold green]Pushed moving tags:[/bold green]")
+            print_to_console(f"[bold green]  - Major:[/bold green] {major_tag}")
+            print_to_console(f"[bold green]  - Minor:[/bold green] {minor_tag}")
 
         # Create a release using GitHub CLI if available
         if create_release and github_repository:
@@ -370,6 +385,7 @@ def patch_with_regex(
 ) -> None:
     """Update a file by replacing the first matched group of every RegEx match with a new version."""
 
+    assert os.path.exists(file_path), f"File missing: {file_path}"
     with open(file_path, "r") as file:
         old_content = file.read()
 
@@ -388,7 +404,7 @@ def patch_with_regex(
     # Compile the regex pattern with multiline support
     regex_pattern = re.compile(regex_pattern, re.MULTILINE)
     matches = list(re.finditer(regex_pattern, old_content))
-    new_content = re.sub(regex_pattern, replace_first_group, old_content, 1)
+    new_content = re.sub(regex_pattern, replace_first_group, old_content, count=1)
 
     non_empty_matches = [m for m in matches if len(m.group(0).strip())]
     assert len(non_empty_matches) > 0, f"No matches found in: {file_path}"
@@ -396,7 +412,7 @@ def patch_with_regex(
     for match in non_empty_matches:
         match_line = old_content.count("\n", 0, match.pos) + 1
         old_slice = match.group(0)
-        new_slice = re.sub(regex_pattern, replace_first_group, old_slice, 1)
+        new_slice = re.sub(regex_pattern, replace_first_group, old_slice, count=1)
 
         if verbose:
             print_to_console(f"[bold cyan]Will update file:[/bold cyan] {file_path}:{match_line}")
@@ -410,117 +426,12 @@ def patch_with_regex(
             print_to_console(f"[bold green]File updated successfully:[/bold green] {file_path}")
 
 
-def validate_commit_with_llms(
-    base_url: str,
-    api_key: str,
-    model: Optional[str],
-    commit: Commit,
-    change: ChangeDiff,
-) -> Optional[Warning]:
-    prompt = f"""
-        You are a professional coding assistant helping me to validate a commit message and its changes.
-        
-        1. Check if the changed code is likely to introduce logical bugs.
-        2. Check if the commit message is likely to contain a vulnerability.
-        3. Check if it contains a breaking change that is likely to affect users.
-        4. Check if the documentation wasn't updated for the changes made.
-
-        Don't let the commit message fool you, just look at the changes made in the code.
-        Reply by choosing any number from 0 to 4 and describe the issue, if anything is found.
-
-        0. No issues found.
-        1. The commit may introduce logical bugs, such as the overflow in ...
-        2. The commit may contain a vulnerability, such as the SQL injection in ...
-        3. The commit may contain a breaking change, such as the removal of ...
-        4. The commit may lack documentation updates for the changes made in function ...
-        """
-    message = f"""
-        #{commit.hash}: {commit.message}
-
-        Changes:
-
-        {change}
-        """
-    client = get_open_ai_client(base_url=base_url, api_key=api_key)
-    response = client.chat.completions.create(
-        messages=[
-            {"role": "system", "content": prompt},
-            {"role": "user", "content": message},
-        ],
-        max_tokens=256,
-        model=model,
-        stream=False,
-    )
-    response_text = response.choices[0].message.content
-    if response_text.startswith("0."):
-        return None
-    if response_text.startswith("1."):
-        return MayContainLogicalBugs(response_text)
-    if response_text.startswith("2."):
-        return MayContainVulnerability(response_text)
-    if response_text.startswith("3."):
-        return MayContainBreakingChange(response_text)
-    if response_text.startswith("4."):
-        return MayLackDocumentation(response_text)
-    return UnknownCommitWarning(response_text)
-
-
-def aggregate_release_notes_with_llms(
-    base_url: str,
-    api_key: str,
-    model: Optional[str],
-    github_repository: str,
-    commits: List[Commit],
-    changes: List[ChangeDiff],
-) -> str:
-
-    commits_with_hashes = "\n".join(f"- {commit.hash}: {commit.message}" for commit in commits)
-    prompt = f"""
-        You are a release notes generator for an advanced software project.
-
-        Aggregate the release notes for the upcoming version based on the commits and their 
-        changes replying in a Github-flavored Markdown format.
-
-        - Mention the new features, improvements, and bug fixes.
-        - Warn about potential breaking changes and vulnerabilities.
-        - Tag people and teams responsible for the changes.
-        - For the most important commits provide a link to the issue or pull request and 
-          a URL to that commit, like [commit](https://github.com/{github_repository}/commit/...).
-        - Don't guess anything, only use the information from the commits and their changes.
-        - Use inline math notation, like $\\beta=1$ or math blocks like the following, when needed:
-
-          ```math
-          \\S_i(A, B, \\alpha, \\beta) = \\alpha \\cdot A_i + \\beta \\cdot B_i
-          ```
-
-        - Use alerting quotes, like: [!CAUTION] or [!TIP], when needed.
-    """
-    header_message = f"""Commits:
-
-    {commits_with_hashes}
-    """
-    changes_messages = [f"#{commit.hash}: {commit.message}\n{change}" for commit, change in zip(commits, changes)]
-
-    client = OpenAI(base_url=base_url, api_key=api_key)
-    response = client.chat.completions.create(
-        messages=[
-            {"role": "system", "content": prompt},
-            {"role": "user", "content": header_message},
-            *[{"role": "user", "content": message} for message in changes_messages],
-        ],
-        max_tokens=2048,
-        model=model,
-        stream=False,
-    )
-    return response.choices[0].message.content
-
-
 def bump(
     *,  # enforce keyword-only arguments
     dry_run: bool = False,
     verbose: bool = False,
     major_verbs: List[str] = ["major", "breaking", "break"],
-    minor_verbs: List[str] = ["minor", "feature", "add", "new"],
+    minor_verbs: List[str] = ["minor", "feature", "feat", "add", "new"],
     patch_verbs: List[str] = ["patch", "fix", "bug", "improve", "docs", "make"],
     path: Optional[PathLike] = None,  # takes current directory as default
     changelog_file: Optional[PathLike] = None,  # relative or absolute path to the changelog file
@@ -534,11 +445,9 @@ def bump(
     push: bool = True,
     github_token: Optional[str] = None,
     github_repository: Optional[str] = None,
-    openai_base_url: str = "https://api.openai.com",
-    openai_api_key: Optional[str] = None,
-    openai_model: Optional[str] = None,
     default_branch: str = "main",
     create_release: bool = False,
+    push_moving_tags: bool = False,
 ) -> SemVer:
     """Primary function used to update the files (version, changelog, etc.), create a new Git tag, push it to a GitHub repository.
     It can be used for dry-runs to preview the changes without actually creating a new tag.
@@ -562,9 +471,6 @@ def bump(
         push (bool): If True, pushes the changes to the remote GitHub repository. Defaults to True.
         github_token (Optional[str]): The GitHub token for authentication. If None, it attempts to use the GH_TOKEN environment variable. Defaults to None.
         github_repository (Optional[str]): The GitHub repository in 'owner/repo' format. If None, it attempts to use the GH_REPOSITORY environment variable. Defaults to None.
-        openai_base_url (str): The OpenAI API base URL. Defaults to "https://api.openai.com".
-        openai_api_key (Optional[str]): The OpenAI API key. Defaults to None.
-        openai_model (Optional[str]): The OpenAI model to use for text generation. Defaults to None.
         default_branch (str): The default branch to push the changes to. Defaults to "main".
 
     Returns:
@@ -574,12 +480,16 @@ def bump(
     repository_path = os.path.abspath(path) if path else os.getcwd()
     assert os.path.isdir(os.path.join(repository_path, ".git")), f"Not a Git repository: {repository_path}"
 
-    def normalize_path(file_path: str) -> str:
-        if not file_path or len(file_path) == 0:
+    def normalize_path(file_path) -> str:
+        if not file_path:
             return None
-        if os.path.isabs(file_path):
-            return file_path
-        return os.path.join(repository_path, file_path)
+        # Convert `pathlib.Path` to `str`
+        file_path_str = str(file_path) if hasattr(file_path, '__fspath__') or isinstance(file_path, os.PathLike) else file_path
+        if not file_path_str or len(file_path_str) == 0:
+            return None
+        if os.path.isabs(file_path_str):
+            return file_path_str
+        return os.path.join(repository_path, file_path_str)
 
     changelog_file = normalize_path(changelog_file)
     version_file = normalize_path(version_file)
@@ -613,7 +523,7 @@ def bump(
     ), f"Changelog file is missing or isn't a regular file: {changelog_file}"
 
     major_verbs = normalize_verbs(major_verbs, ["major", "breaking", "break"])
-    minor_verbs = normalize_verbs(minor_verbs, ["minor", "feature", "add", "new"])
+    minor_verbs = normalize_verbs(minor_verbs, ["minor", "feature", "feat", "add", "new"])
     patch_verbs = normalize_verbs(patch_verbs, ["patch", "fix", "bug", "improve", "docs", "make"])
 
     last_tag = get_last_tag(repository_path)
@@ -621,16 +531,16 @@ def bump(
 
     current_version = parse_version(last_tag)
     if verbose:
-        print(f"Current version: {current_version[0]}.{current_version[1]}.{current_version[2]}")
+        print_to_console(f"Current version: {current_version[0]}.{current_version[1]}.{current_version[2]}")
 
     commits = get_commits_since_tag(repository_path, last_tag)
     if not len(commits):
         raise NoNewCommitsError(f"No new commits since the last {last_tag} tag")
 
     if verbose:
-        print(f"? Commits since last tag: {len(commits)}")
+        print_to_console(f"? Commits since last tag: {len(commits)}")
         for hash, commit in commits:
-            print(f"# {hash}: {commit}")
+            print_to_console(f"# {hash}: {commit}")
 
     major_commits, minor_commits, patch_commits = group_commits(commits, major_verbs, minor_verbs, patch_verbs)
     assert (
@@ -645,7 +555,7 @@ def bump(
         bump_type = "patch"
     new_version = bump_version(current_version, bump_type)
     if verbose:
-        print(f"Next version: {new_version[0]}.{new_version[1]}.{new_version[2]} (type: {bump_type})")
+        print_to_console(f"Next version: {new_version[0]}.{new_version[1]}.{new_version[2]} (type: {bump_type})")
 
     new_version_str = f"{new_version[0]}.{new_version[1]}.{new_version[2]}"
     if version_file:
@@ -656,12 +566,12 @@ def bump(
         changes = f"\n## {now:%B %d, %Y}: v{new_version_str}\n"
         changes += convert_commits_to_message(major_commits, minor_commits, patch_commits)
 
-        print(f"Will update file: {changelog_file}")
+        print_to_console(f"Will update file: {changelog_file}")
         if verbose:
             changes_lines = changes.count("\n") + 1
-            print(f"? Appending {changes_lines} lines")
+            print_to_console(f"? Appending {changes_lines} lines")
             for line in changes.split("\n"):
-                print(f"+ {line}")
+                print_to_console(f"+ {line}")
 
         if not dry_run:
             with open(changelog_file, "a") as file:
@@ -680,43 +590,6 @@ def bump(
         for file_path, regex_pattern in update_patch_version_in:
             patch_with_regex(file_path, regex_pattern, str(new_version[2]), dry_run=dry_run, verbose=verbose)
 
-    # Now log the potential issues with the commits
-    if openai_api_key:
-        warnings_commits = []
-        warnings = []
-        changes = [get_diff_for_commit(repository_path, commit.hash) for commit in commits]
-        for commit, change in zip(commits, changes):
-            try:
-                warning = validate_commit_with_llms(
-                    base_url=openai_base_url,
-                    api_key=openai_api_key,
-                    model=openai_model,
-                    commit=commit,
-                    change=change,
-                )
-                if warning:
-                    warnings_commits.append(commit)
-                    warnings.append(warning)
-            except Exception as e:
-                print(f"Failed to validate commit: {commit.hash} with error: {str(e)}")
-                traceback.print_exc()
-
-        if len(warnings):
-            print("## Potential issues")
-            for commit, warning in zip(warnings_commits, warnings):
-                print(f"- Commit #{commit.hash}: {warning}")
-
-        release_notes = aggregate_release_notes_with_llms(
-            base_url=openai_base_url,
-            api_key=openai_api_key,
-            model=openai_model,
-            github_repository=github_repository,
-            commits=commits,
-            changes=changes,
-        )
-        print("## Generated release notes:")
-        print(release_notes)
-
     if not dry_run:
         create_tag(
             repository_path=repository_path,
@@ -728,11 +601,14 @@ def bump(
             github_repository=github_repository,
             push=push,
             create_release=create_release,
+            push_moving_tags=push_moving_tags,
             major_commits=major_commits,
             minor_commits=minor_commits,
             patch_commits=patch_commits,
         )
 
+    return new_version
+
 
 def main():
     """
@@ -834,25 +710,18 @@ def main():
             "--github-repository",
             help="GitHub repository in the 'owner/repo' format, if not set will use GH_REPOSITORY env var",
         )
-        parser.add_argument(
-            "--openai-base-url",
-            default="https://api.openai.com",
-            help="OpenAI API base URL",
-        )
-        parser.add_argument(
-            "--openai-api-key",
-            help="OpenAI API key for text generation",
-        )
-        parser.add_argument(
-            "--openai-model",
-            help="OpenAI model to use for text generation (e.g., 'text-davinci-003' or 'text-davinci-002')",
-        )
         parser.add_argument(
             "--create-release",
             action="store_true",
             default=False,
             help="Create a GitHub release using the GitHub CLI",
         )
+        parser.add_argument(
+            "--push-moving-tags",
+            action="store_true",
+            default=False,
+            help="Push moving major and minor version tags (requires force-push permissions)",
+        )
         args = parser.parse_args()
     else:
 
@@ -864,7 +733,7 @@ def main():
         args.verbose = os.environ.get("TINYSEMVER_VERBOSE", "").lower() == "true"
         args.push = os.environ.get("TINYSEMVER_PUSH", "").lower() == "true"
         args.major_verbs = os.environ.get("TINYSEMVER_MAJOR_VERBS") or "breaking,break,major"
-        args.minor_verbs = os.environ.get("TINYSEMVER_MINOR_VERBS") or "feature,minor,add,new"
+        args.minor_verbs = os.environ.get("TINYSEMVER_MINOR_VERBS") or "feature,feat,minor,add,new"
         args.patch_verbs = os.environ.get("TINYSEMVER_PATCH_VERBS") or "fix,patch,bug,improve,docs,make"
         args.default_branch = os.environ.get("TINYSEMVER_DEFAULT_BRANCH") or "main"
         args.changelog_file = os.environ.get("TINYSEMVER_CHANGELOG_FILE")
@@ -894,10 +763,8 @@ def main():
         args.git_user_email = os.environ.get("TINYSEMVER_GIT_USER_EMAIL", "tinysemver@ashvardanian.com")
         args.github_token = os.environ.get("GITHUB_TOKEN")
         args.github_repository = os.environ.get("GITHUB_REPOSITORY")
-        args.openai_base_url = os.environ.get("OPENAI_BASE_URL", "https://api.openai.com")
-        args.openai_api_key = os.environ.get("OPENAI_API_KEY")
-        args.openai_model = os.environ.get("OPENAI_MODEL")
         args.create_release = os.environ.get("TINYSEMVER_CREATE_RELEASE", "").lower() == "true"
+        args.push_moving_tags = os.environ.get("TINYSEMVER_PUSH_MOVING_TAGS", "").lower() == "true"
 
     # It's common for a CI pipeline to have multiple broken settings or missing files.
     # For the best user experience, we want to catch all errors and print them at once,
@@ -925,11 +792,9 @@ def main():
             git_user_email=args.git_user_email,
             github_token=args.github_token,
             github_repository=args.github_repository,
-            openai_base_url=args.openai_base_url,
-            openai_api_key=args.openai_api_key,
-            openai_model=args.openai_model,
             push=args.push,
             create_release=args.create_release,
+            push_moving_tags=args.push_moving_tags,
         )
     except NoNewCommitsError as e:
         print(f"! {e}")
@@ -938,7 +803,7 @@ def main():
         print(f"! {e}")
         exit(1)
     except Exception as e:
-        traceback.print_exc(e)
+        traceback.print_exc()
         exit(1)
 
 

{tinysemver-2.1.0 → tinysemver-3.0.0/tinysemver.egg-info}/PKG-INFO

@@ -1,8 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tinysemver
-Version: 2.1.0
-Summary: Semantic-Versioning with LLMs and without 300,000 lines of JS
-Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
+Version: 3.0.0
+Summary: Semantic-Versioning... that doesn't need 300,000 lines of JS
+Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
@@ -206,10 +206,10 @@ License:                                  Apache License
            limitations under the License.
         
 Project-URL: Homepage, https://pypi.org/project/tinysemver/
-Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main/README.md
-Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
-Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
-Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/ashvardanian/TinySemVer/blob/main/README.md
+Project-URL: Repository, https://github.com/ashvardanian/TinySemVer.git
+Project-URL: Issues, https://github.com/ashvardanian/TinySemVer/issues
+Project-URL: Changelog, https://github.com/ashvardanian/TinySemVer/blob/main/CHANGELOG.md
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
@@ -223,12 +223,23 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: openai>=1.54.4
 Requires-Dist: rich>=13.8.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Dynamic: license-file
 
 ![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -306,19 +317,6 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
-## AI and Rock-n-Roll
-
-TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
-
-```sh
-$ tinysemver --verbose \
-    --github-repository 'ashvardanian/tinysemver' \
-    --openai-base-url 'https://api.groq.com/openai/v1' \
-    --openai-api-key 'GET_YOURSELF_A_KEY' \
-    --openai-model 'llama-3.2-11b-text-preview' \
-    --dry-run
-```
-
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.
@@ -337,12 +335,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
       with:
         persist-credentials: false # Only if main branch if protected
 
     - name: Run TinySemVer
-      uses: ashvardanian/tinysemver@v2.0.1
+      uses: ashvardanian/tinysemver@v3 # Automatically receives non-breaking updates
       with:
         major-verbs: 'breaking,break,major'
         minor-verbs: 'feature,minor,add,new'
@@ -363,7 +361,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: main # Take the most recent updated version
 ```
@@ -382,6 +380,30 @@ If you need to update the version in multiple files, pass a multiline string wit
 
 For examples, consider checking StringZilla, USearch, and other libraries using TinySemVer.
 
+Since version 3.0.0, TinySemVer can optionally maintain moving version tags similar to `actions/checkout@v4`:
+
+```yaml
+uses: ashvardanian/tinysemver@v3       # Automatically gets non-breaking updates
+uses: ashvardanian/tinysemver@v3.0     # Automatically gets patch updates
+uses: ashvardanian/tinysemver@v3.0.0   # Pinned, never changes
+uses: ashvardanian/tinysemver@main     # Bleeding edge
+```
+
+This feature is disabled by default because it requires force-push permissions.
+To enable it, add `push-moving-tags: 'true'` and ensure your token has force-push access:
+
+```yaml
+    - name: Run TinySemVer
+      uses: ashvardanian/tinysemver@v3
+      with:
+        push: 'true'
+        push-moving-tags: 'true'
+        github-token: ${{ secrets.TINYSEMVER_TOKEN }}
+```
+
+When enabled, TinySemVer creates three tags: `v3` (major), `v3.0` (minor), and `v3.0.0` (specific).
+The default `GITHUB_TOKEN` typically lacks force-push permissions for protected branches.
+
 ### Security Considerations
 
 If your default branch is protected with a "pull request before merging" rule:

tinysemver-3.0.0/tinysemver.egg-info/requires.txt

@@ -0,0 +1,14 @@
+rich>=13.8.0
+
+[dev]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+pytest-mock>=3.10.0
+ruff>=0.1.0
+mypy>=1.0.0
+black>=23.0.0
+
+[test]
+pytest>=7.0.0
+pytest-cov>=4.0.0
+pytest-mock>=3.10.0

tinysemver-2.1.0/tinysemver.egg-info/requires.txt

@@ -1,2 +0,0 @@
-openai>=1.54.4
-rich>=13.8.0