Merge branch 'main' into develop

Author: roumail

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 1.1.0
+commit = True
+tag = True
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:CHANGELOG.md]
+search =  ## [Unreleased]
+replace = ## [Unreleased]\\n\\n## [{new_version}] - {now:%Y-%m-%d}

.github/workflows/release-package.yaml

@@ -23,8 +23,8 @@ jobs:
 
     - name: Install Python dependencies
       run: |
-        pip install setuptools wheel toml bump2version
-        pip install -e .
+        pip install -e ".[dev]"
+        pip install build
 
     # TODO: Add a better way to determine type of version change
     - name: Determine Bump Type
@@ -40,8 +40,8 @@ jobs:
       run: |
         git config --local user.email "[email protected]"
         git config --local user.name "GitHub Action"
-        python bump_version.py ${{ env.bump_type }}        
-        PACKAGE_VERSION=$(python -c 'import toml; print(toml.load("pyproject.toml")["project"]["version"])')
+        python release.py ${{ env.bump_type }}        
+        PACKAGE_VERSION=$(sed -n 's/^version *= *"\(.*\)"/\1/p' pyproject.toml)
         echo "PACKAGE_VERSION=$PACKAGE_VERSION" >> $GITHUB_ENV
             
     - name: Build Package

.gitignore

@@ -1,6 +1,7 @@
 dist/
 assets/jsconfig.json
 
+dist/
 # cache
 **/__pycache__
 # IDE specific

CHANGELOG.md

@@ -10,6 +10,13 @@ and this project adheres to
 
 ### Fixed
 
+- Removed poetry from dependencies for building and releasing the package.
+- Consolidate the bumping of versions to better leverage `bump2version`.
+- `bump_version.py` script is now renamed `release.py`.
+- Removed `toml` as a dev dependency.
+
+### Fixed
+
 - Add back series in the `_index.md` when creating a new series and and remove
   the self-reference at the template level in hugo
 

README.md

@@ -75,7 +75,7 @@ execute:
 1. Install the website package and its development dependencies, follow these
    steps:
    ```bash
-   uv pip install -e .[dev]
+   uv pip install -e ".[dev]"
    ```
 2. `website --help` should list the relevant output
 
@@ -86,8 +86,10 @@ execute:
 
 ## Bumping package version and updating changelog
 
-I'm maintaining a `CHANGELOG.md` for keeping track of changes made to the python
-package. The script `bump_version.py` in the project root provides the utilities
-needed for releasing a new tagged version to remote. The github action
-`.github/workflows/release-package.yaml` is using this script and is triggered
-via a manual dispatch.
+Using the script `release.py`, `bump2version` and the github action
+`.github/workflows/release-package.yaml` I'm automating my package release
+process.
+
+Each new release has a section in the `CHANGELOG.md` under the `[Unreleased]`
+section for keeping track of changes made to the python package since the last
+release.

bump_version.py

@@ -1,43 +1,37 @@
 [build-system]
-requires = ["setuptools >= 61.0"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [project]
 name = "website"
-version = "1.0.6"
+version = "1.1.0"
 description = "Automation and build tools for my website"
-authors = ["Rohail Taimour"]
-license = "MIT"
+authors = [
+  { name = "Rohail Taimour" }
+]
 packages = [
-    { include = "website" },
+  { include = "website" }
 ]
+license = { text = "MIT License" }
 dependencies = [
   "typer>=0.12.3",
 ]
+readme = "README.md"
 requires-python = ">=3.10"
 
-[project.optional-dependencies.dev]
-black = ">=23.7.0"
-isort = ">=5.12.0"
-pre-commit = ">=3.3.3"
-flake8 = ">=6.1.0"
-bump2version = ">=1.0.1"
-toml = ">=0.10.2"
-
+[project.optional-dependencies]
+dev = [
+  "black>=23.7.0",
+  "isort>=5.12.0",
+  "pre-commit>=3.3.3",
+  "flake8>=6.1.0",
+  "bump2version>=1.0.1"
+]
 [project.scripts]
 website = "website.entrypoints:app"
 new-post = 'website.entrypoints:new_post'
 list-draft-posts = 'website.entrypoints:list_draft_posts'
 
-[tool.bumpversion]
-commit = true
-tag = true
-
-[[tool.bumpversion.file]]
-filename = "CHANGELOG.md"
-search = "## [Unreleased]"
-replace = "## [Unreleased]\n\n## [{new_version}] - {now:%Y-%m-%d}"
-
 [tool.black]
 line-length = 88
 target-version = ['py310']

pyproject.toml

@@ -0,0 +1,40 @@
+import subprocess
+import sys
+
+
+def bump_version(bump_type):
+    subprocess.run(["bump2version", bump_type], check=True)
+
+    # Extract the new version from bump2version's output
+    result = subprocess.run(
+        ["bump2version", "--dry-run", "--list", bump_type],
+        capture_output=True,
+        text=True,
+    )
+    new_version = None
+    for line in result.stdout.splitlines():
+        if line.startswith("new_version="):
+            new_version = line.split("=")[-1]
+
+    if not new_version:
+        print("Error: Failed to determine the new version.")
+        sys.exit(1)
+    return new_version
+
+
+def main():
+    bump_type = "patch"
+
+    if len(sys.argv) > 1:
+        if sys.argv[1] not in ["patch", "minor", "major"]:
+            print("Invalid bump type. Use 'patch', 'minor', or 'major'.")
+            sys.exit(1)
+        bump_type = sys.argv[1]
+
+    # Bump the version
+    new_version = bump_version(bump_type)
+    print(f"Bumped version to {new_version}")
+
+
+if __name__ == "__main__":
+    main()