Merge pull request #6 from akshatnerella/akshatnerella/versioning-fix

changed CI to commit package version during PR

Author: akshatnerella

.github/scripts/bump_version.py

@@ -0,0 +1,84 @@
+import argparse
+import os
+import re
+import subprocess
+from pathlib import Path
+
+
+def run(*args: str) -> str:
+    return subprocess.check_output(args, text=True).strip()
+
+
+def write_output(key: str, value: str) -> None:
+    output_path = os.getenv("GITHUB_OUTPUT")
+    if not output_path:
+        return
+    with open(output_path, "a", encoding="utf-8") as fh:
+        fh.write(f"{key}={value}\n")
+
+
+def parse_setup_version(text: str) -> str:
+    match = re.search(r"version\s*=\s*['\"](\d+\.\d+\.\d+)['\"]", text)
+    if not match:
+        raise RuntimeError("Could not parse version from setup.py")
+    return match.group(1)
+
+
+def latest_tag_version() -> str | None:
+    tags = run("git", "tag", "--list", "v*", "--sort=-v:refname").splitlines()
+    for tag in tags:
+        if re.fullmatch(r"v\d+\.\d+\.\d+", tag):
+            return tag[1:]
+    return None
+
+
+def base_branch_version(base_ref: str) -> str:
+    setup_on_base = run("git", "show", f"origin/{base_ref}:setup.py")
+    return parse_setup_version(setup_on_base)
+
+
+def bump_version(version: str, bump: str) -> str:
+    major, minor, patch = [int(part) for part in version.split(".")]
+    if bump == "major":
+        return f"{major + 1}.0.0"
+    if bump == "minor":
+        return f"{major}.{minor + 1}.0"
+    return f"{major}.{minor}.{patch + 1}"
+
+
+def update_setup(new_version: str) -> bool:
+    setup_path = Path("setup.py")
+    original = setup_path.read_text(encoding="utf-8")
+    updated, replacements = re.subn(
+        r"version\s*=\s*['\"]\d+\.\d+\.\d+['\"]",
+        f"version='{new_version}'",
+        original,
+        count=1,
+    )
+    if replacements == 0:
+        raise RuntimeError("Could not find version assignment in setup.py")
+    if updated == original:
+        return False
+    setup_path.write_text(updated, encoding="utf-8")
+    return True
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--bump", choices=["major", "minor", "patch"], required=True)
+    parser.add_argument("--base-ref", required=True)
+    args = parser.parse_args()
+
+    setup_text = Path("setup.py").read_text(encoding="utf-8")
+    current_version = parse_setup_version(setup_text)
+    base_version = latest_tag_version() or base_branch_version(args.base_ref)
+    target_version = bump_version(base_version, args.bump)
+
+    changed = update_setup(target_version)
+    write_output("version", target_version)
+    write_output("changed", "true" if changed else "false")
+    print(f"current={current_version} base={base_version} target={target_version} changed={changed}")
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/pr_bump_version.py

@@ -0,0 +1,92 @@
+name: PR Version Bump
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  bump-version:
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Determine bump label
+        id: label
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const labels = context.payload.pull_request.labels.map(l => l.name);
+            let bump = "patch";
+            if (labels.includes("release:major")) {
+              bump = "major";
+            } else if (labels.includes("release:minor")) {
+              bump = "minor";
+            } else if (labels.includes("release:patch")) {
+              bump = "patch";
+            } else {
+              try {
+                await github.rest.issues.addLabels({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  issue_number: context.payload.pull_request.number,
+                  labels: ["release:patch"]
+                });
+              } catch (error) {
+                if (error.status !== 422) {
+                  throw error;
+                }
+                await github.rest.issues.createLabel({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  name: "release:patch",
+                  color: "0e8a16",
+                  description: "Patch version bump"
+                });
+                await github.rest.issues.addLabels({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  issue_number: context.payload.pull_request.number,
+                  labels: ["release:patch"]
+                });
+              }
+            }
+            core.setOutput("bump", bump);
+
+      - name: Checkout PR branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          fetch-depth: 0
+
+      - name: Fetch base branch and tags
+        run: |
+          git fetch origin "${{ github.event.pull_request.base.ref }}"
+          git fetch --tags
+
+      - name: Bump setup.py version
+        id: bump
+        run: |
+          python .github/scripts/pr_bump_version.py \
+            --bump "${{ steps.label.outputs.bump }}" \
+            --base-ref "${{ github.event.pull_request.base.ref }}"
+
+      - name: Commit and push version update
+        if: steps.bump.outputs.changed == 'true'
+        env:
+          NEW_VERSION: ${{ steps.bump.outputs.version }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add setup.py
+          git commit -m "chore: bump version to ${NEW_VERSION}"
+          git push origin "HEAD:${{ github.event.pull_request.head.ref }}"

.github/workflows/pr-version-bump.yml

@@ -2,13 +2,13 @@ name: Publish to PyPI
 
 on:
   push:
-    tags:
-      - "v*.*.*"
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:
   publish:
-    if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/v')
+    if: github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     permissions:
       contents: read

.github/workflows/publish.yml

@@ -106,16 +106,17 @@ We welcome contributions to add new features, fix bugs, and improve documentatio
 
 This repository is configured with GitHub Actions:
 - `CI`: runs tests on pull requests and pushes to `main`.
-- `Auto Version Release`: on each merge/push to `main`, it auto-bumps version in `setup.py`, creates a git tag (for example `v0.1.1`), and pushes it.
-- `Publish to PyPI`: builds and uploads the package when a release tag is pushed.
+- `PR Version Bump`: when a pull request is opened/updated, it checks release labels and commits a version bump to `setup.py` directly in the PR branch.
+- `Publish to PyPI`: builds and uploads the package when code is merged/pushed to `main`.
 
 One-time setup required:
 1. Create a PyPI API token (`__token__`) for your PyPI project.
 2. In GitHub: `Settings -> Secrets and variables -> Actions`, add a repository secret named `PYPI_API_TOKEN`.
-3. Use conventional commit messages in merged commits/PR titles for semantic bumps:
-   - `feat:` -> minor bump
-   - `fix:` (or anything else) -> patch bump
-   - `BREAKING CHANGE` or `feat!:` / `fix!:` -> major bump
+3. Use one release label on PRs:
+   - `release:major`
+   - `release:minor`
+   - `release:patch`
+4. If no release label is present, the workflow automatically adds `release:patch` and bumps patch version.
 
 If the version already exists on PyPI, publish is skipped safely.
 

.github/workflows/release.yml

@@ -2,7 +2,7 @@
 
 setup(
     name='pyladdersim',
-    version='0.1.0',
+    version='0.1.1',
     packages=find_packages(exclude=["tests", "tests.*"]),
     install_requires=[
         'matplotlib',