Merge pull request #5 from 56kyle/release/0.1.0

Release/0.1.0

Author: 56kyle

.cookiecutter.json

@@ -1,5 +1,5 @@
 {
-  "_commit": "dab1f8da6cb6be90a50db1aafb4411ec61fbcb2c",
+  "_commit": "e75916b0cb7d49cc8b12acaf0af9098ec3ccca28",
   "_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": "e75916b0cb7d49cc8b12acaf0af9098ec3ccca28",
   "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": "e75916b0cb7d49cc8b12acaf0af9098ec3ccca28"
     }
   },
   "directory": null

.github/workflows/bump-version.yml

@@ -0,0 +1,52 @@
+name: Prepare Release
+
+on:
+  push:
+    branches:
+      - "release/*"
+
+permissions:
+  contents: write
+
+jobs:
+  prepare-release:
+    name: Prepare Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: .github/workflows/.python-version
+
+      - name: Get Current Version
+        id: current_version
+        run: echo "CURRENT_VERSION=$(uvx --from commitizen cz version -p)" >> $GITHUB_OUTPUT
+
+      - name: Get New Release Version
+        id: new_version
+        run: echo "NEW_VERSION=${GITHUB_REF_NAME#release/}" >> $GITHUB_OUTPUT
+
+      - name: Bump Version
+        if: ${{ steps.current_version.outputs.CURRENT_VERSION != steps.new_version.outputs.NEW_VERSION }}
+        run: uvx nox -s bump-version ${{ steps.new_version.outputs.NEW_VERSION }}
+
+      - name: Get Release Notes
+        run: uvx nox -s get-release-notes -- ${{ github.workspace }}-CHANGELOG.md
+
+      - name: Create Release Draft
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: ${{ github.workspace }}-CHANGELOG.md
+          draft: true
+          tag_name: ${{ steps.new_version.outputs.NEW_VERSION }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/prepare-release.yml

@@ -5,21 +5,41 @@ name: Release Python Package
 
 on:
   push:
-    tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
-      - "v[0-9]+.[0-9]+.[0-9]+-*" # Include pre-release tags
+    branches:
+      - main
+      - master
 
   workflow_dispatch:
-    inputs:
-      tag:
-        description: "Git tag to build and release (e.g., v1.2.3). Must already exist."
-        required: true
 
 jobs:
+  get_tag:
+    name: Get Tag
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.current_version.outputs.CURRENT_VERSION }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".github/workflows/.python-version"
+
+      - name: Get Current Version
+        id: current_version
+        run: echo "CURRENT_VERSION=$(uvx --from commitizen cz version -p)" >> $GITHUB_OUTPUT
+
+
   build_and_testpypi:
     name: Build & Publish to TestPyPI
     runs-on: ubuntu-latest
-
+    needs: get_tag
+    outputs:
+      tag: ${{ needs.get_tag.outputs.tag }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -44,7 +64,7 @@ jobs:
       - name: Download built package artifacts
         uses: actions/download-artifact@v4
         with:
-          name: distribution-packages-${{ github.event.inputs.tag }}
+          name: distribution-packages-${{ needs.get_tag.outputs.tag }}
           path: dist/
 
       - name: Publish to TestPyPI
@@ -53,24 +73,11 @@ jobs:
           TWINE_PASSWORD: ${{ secrets.TESTPYPI_API_TOKEN }}
         run: uvx nox -s publish-package -- --repository testpypi
 
-      - name: Get Release Notes from Changelog
-        id: changelog
-        uses: simple-changelog/action@v3
-        with:
-          path: CHANGELOG.md
-          tag: ${{ github.event_name == 'push' && github.ref_name || github.event.inputs.tag }}
-
-    outputs:
-      changelog_body:
-        description: "Release notes body extracted from CHANGELOG.md"
-        value: ${{ steps.changelog.outputs.changes }} # Output the extracted changelog body
-
-  publish_pypi:
-    name: Publish to Production PyPI
+  publish_pypi_and_github:
+    name: Publish to Production PyPI and GitHub
     runs-on: ubuntu-latest
     needs: build_and_testpypi
 
-    if: "github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')"
     steps:
       - name: Download package artifacts
         uses: actions/download-artifact@v4
@@ -86,34 +93,18 @@ jobs:
       - name: Set up uv
         uses: astral-sh/setup-uv@v6
 
+      - name: Create Tag
+        run: |
+          git tag ${{ needs.build_and_testpypi.outputs.tag }}
+          git push origin ${{ needs.build_and_testpypi.outputs.tag }}
+
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
         run: uvx nox -s publish-python
 
-  create_github_release:
-    name: Create GitHub Release
-    runs-on: ubuntu-latest
-    needs: build_and_testpypi
-
-    if: "github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')"
-
-    steps:
-      - name: Download package artifacts # Get built artifacts for release assets
-        uses: actions/download-artifact@v4
-        with:
-          name: distribution-packages
-
-      - name: Get tag name
-        id: get_tag
-        run: echo "tag=${{ github.ref_name }}" >> $GITHUB_OUTPUT
-
-      - name: Create GitHub Release
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: ${{ steps.get_tag.outputs.tag }}
-          name: Release ${{ steps.get_tag.outputs.tag }}
-          body: ${{ needs.build_and_testpypi.outputs.changelog_body }}
-          files: dist/*
-          prerelease: ${{ contains(steps.get_tag.outputs.tag, '-') }} # Checks if tag contains hyphen (e.g. v1.0.0-rc.1)
+      - name: Publish to GitHub
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload ${{ needs.build_and_testpypi.outputs.tag }} dist/

.github/workflows/release-python.yml

@@ -71,3 +71,6 @@ nohup.out
 
 # Prettier dependencies
 node_modules/
+
+# Release Notes
+body.md

.gitignore

@@ -98,7 +98,7 @@ max-complexity = 10
 ]
 "exceptions.py" = ["D107"]
 "noxfile.py" = ["S101"]
-"scripts/*" = ["S603"]
+"scripts/*" = ["S603", "S607"]
 
 [lint.pydocstyle]
 convention = "google"

.ruff.toml

@@ -0,0 +1,24 @@
+## v0.1.0 (2025-07-16)
+
+### Feat
+
+- initial commit
+- remove unneeded python venvs from noxfile.py
+- run pre-commit autoupdate
+- initial commit
+- initial commit
+- initial commit
+- add new pre-commit hooks for validating the pyproject.toml
+- initial commit
+- initial commit
+- initial commit
+- initial commit
+- initial commit
+- initial commit
+- initial commit
+
+### Fix
+
+- resolve conflicts
+- resolve conflicts
+- fix path syntax in build-python.yml