Bugfix/auto versioning workflow in pr (#116)

.github/workflows/auto-format.yml → .github/workflows/auto-format-version.yml

@@ -1,18 +1,18 @@
-name: AutoFormatting
+name: Formatting and Version Increment
 
 on:
-  push:
-    branches:
-      - master
-      - develop
   pull_request:
     branches:
       - master
-      - develop
+
+env:
+  SOURCE_BRANCH: ${{ github.head_ref }}
+  BASE_BRANCH: ${{ github.base_ref }}
 
 jobs:
-  code-formatting:
+  code-formatting_increment-version:
     runs-on: ubuntu-latest
+
     steps:
       - name: Check out code
         uses: actions/checkout@v3
@@ -29,6 +29,13 @@ jobs:
         run: |
           pip install -r requirements_test.txt
 
+      - name: Run version increment script
+        id: version_increment
+        run: |
+          python scripts/update_version.py ${{ env.BASE_BRANCH }} ${{ env.SOURCE_BRANCH }}
+          bash scripts/auto_commit.sh "Automated version changes"
+        continue-on-error: true
+
       - name: Updating README files
         id: update_readme
         run: |
@@ -43,8 +50,9 @@ jobs:
           bash scripts/auto_commit.sh "Automated formatting changes"
         continue-on-error: true
 
-      - name: Push changes
-        if: ${{ steps.update_readme.outcome == 'success' || steps.code_format.outcome == 'success' }}
+      - name: Push changes to source branch
+        id: push_to_source_branch
+        if: ${{ steps.version_increment.outcome == 'success' || steps.update_readme.outcome == 'success' || steps.code_format.outcome == 'success' }}
         uses: ad-m/github-push-action@master
         with:
-          branch: ${{ github.head_ref }}
+          branch: ${{ env.SOURCE_BRANCH }}

README.md

@@ -7,7 +7,7 @@
     <img src="https://img.shields.io/github/stars/fmilthaler/FinQuant.svg?style=social&label=Star" alt='pypi'>
   </a>
   <a href="https://pypi.org/project/FinQuant">
-    <img src="https://img.shields.io/badge/pypi-v0.4.0-brightgreen.svg?style=popout" alt='pypi'>
+    <img src="https://img.shields.io/badge/pypi-v0.4.1-brightgreen.svg?style=popout" alt='pypi'>
   </a>
   <a href="https://github.com/fmilthaler/FinQuant">
     <img src="https://github.com/fmilthaler/finquant/actions/workflows/pytest.yml/badge.svg?branch=master" alt='GitHub Actions'>

README.tex.md

@@ -7,7 +7,7 @@
     <img src="https://img.shields.io/github/stars/fmilthaler/FinQuant.svg?style=social&label=Star" alt='pypi'>
   </a>
   <a href="https://pypi.org/project/FinQuant">
-    <img src="https://img.shields.io/badge/pypi-v0.4.0-brightgreen.svg?style=popout" alt='pypi'>
+    <img src="https://img.shields.io/badge/pypi-v0.4.1-brightgreen.svg?style=popout" alt='pypi'>
   </a>
   <a href="https://github.com/fmilthaler/FinQuant">
     <img src="https://github.com/fmilthaler/finquant/actions/workflows/pytest.yml/badge.svg?branch=master" alt='GitHub Actions'>

scripts/update_version.py

@@ -1,5 +1,7 @@
 import argparse
 import re
+import subprocess
+import sys
 
 # Define the version increments based on the change type (patch, minor, major)
 version_increments = {
@@ -20,6 +22,10 @@ class VersionFileReadError(Exception):
     pass
 
 
+class VersionUpdateError(Exception):
+    pass
+
+
 # Function to increment the version based on the branch name pattern
 def increment_version(version, branch_name):
     for change_type, prefixes in branch_prefixes.items():
@@ -74,6 +80,43 @@ def read_version_from_file(filename):
         return version
 
 
+# Function to checkout a specific branch
+def checkout_branch(branch_name):
+    # Fetch the latest changes from the remote repository
+    subprocess.run(["git", "fetch", "origin", branch_name], check=True)
+
+    # Checkout the branch to access its content
+    subprocess.run(["git", "checkout", branch_name], check=True)
+
+
+# Function to get version number from a specific branch
+def get_version_from_branch(filename, branch_name):
+    # Checkout branch
+    checkout_branch(branch_name)
+
+    # Get version from version file
+    version = read_version_from_file(filename)
+
+    # Read the version from the file
+    return version
+
+
+# Function to compare 2 strings of version numbers
+def compare_versions(version1, version2):
+    def parse_version(version_str):
+        return tuple(map(int, version_str.split(".")))
+
+    parsed_version1 = parse_version(version1)
+    parsed_version2 = parse_version(version2)
+
+    if parsed_version1 < parsed_version2:
+        return -1
+    elif parsed_version1 > parsed_version2:
+        return 1
+    else:
+        return 0
+
+
 # Write the updated version back to the file
 def write_version_to_file(filename, version):
     with open(filename, "r+") as file:
@@ -106,27 +149,50 @@ def main():
 
     file_path = "version"
 
-    if base_branch_name not in ["master", "develop"]:
-        raise ValueError("Base branch name must be 'master' or 'develop'.")
+    if base_branch_name != "master":
+        raise ValueError("Base branch name must be 'master'.")
 
     if source_branch_name is None:
         raise ValueError("Source branch name must not be empty/None.")
 
-    current_version = read_version_from_file(file_path)
-    if current_version is None:
-        raise VersionFileReadError("Failed to read the current version from the file.")
+    # Get the version from the base branch
+    current_version_base = get_version_from_branch(file_path, base_branch_name)
+    # Get the version from source branch
+    current_version_source = get_version_from_branch(file_path, source_branch_name)
+
+    # Sanity check for version numbers of base and source branch
+    if current_version_base is None or current_version_source is None:
+        raise VersionFileReadError(
+            f"Failed to read the version from {base_branch_name} or from branch."
+        )
+
+    # Increment the version based on the branch name pattern
+    updated_version = increment_version(current_version_base, source_branch_name)
 
-    updated_version = increment_version(current_version, source_branch_name)
     print(f"Base branch: {base_branch_name}")
     print(f"Source branch: {source_branch_name}")
-    print(f"Current version: {current_version}")
+    print(f"Current version (base):   {current_version_base}")
+    print(f"Current version (source): {current_version_source}")
     print(f"Updated version: {updated_version}")
 
-    if updated_version == current_version:
-        print("Version did not change.")
-    else:
-        write_version_to_file(file_path, updated_version)
-        print("Version updated in the file.")
+    # Check if updated version is higher than version in base branch:
+    version_comparison = compare_versions(updated_version, current_version_base)
+    if version_comparison < 0:
+        raise VersionUpdateError(
+            "Error: Updated version is lower than version in base branch."
+        )
+    elif version_comparison == 0:
+        print("Version does not increase.")
+        # Exit with error code 1
+        sys.exit(1)
+    elif version_comparison > 0:
+        if updated_version == current_version_source:
+            print("Version is already updated.")
+            # Exit with error code 1
+            sys.exit(1)
+        else:
+            write_version_to_file(file_path, updated_version)
+            print("Version updated in the file 'version'.")
 
 
 if __name__ == "__main__":

version

@@ -1,2 +1,2 @@
-version=0.4.0
-release=0.4.0
+version=0.4.1
+release=0.4.1