Refactor GitHub Actions workflow for building and releasing: update job names, improve comments, and streamline release creation process.

Author: rish-hyun

.github/workflows/publish.yml

@@ -1,29 +1,30 @@
-name: Build, Tag & Publish Pixelcore
+name: Build, Release & Publish Pixelcore
 
-# Only trigger on push to master
 on:
   push:
     branches:
       - master
 
 jobs:
-  tag-build-publish:
+  release:
     runs-on: ubuntu-latest
     env:
       PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
     steps:
-      # 1. Checkout code
+      # 1. Checkout full repo
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # full history
 
       # 2. Set up Python
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
 
-      # 3. Install dependencies for building
-      - name: Install build dependencies
+      # 3. Install build dependencies
+      - name: Install build tools
         run: |
           python -m pip install --upgrade pip
           pip install toml build twine
@@ -34,35 +35,34 @@ jobs:
         run: |
           VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
           echo "VERSION=$VERSION" >> $GITHUB_ENV
-          echo "Version read from pyproject.toml: $VERSION"
+          echo "Version read: $VERSION"
 
-      # 5. Auto-tag if tag does not exist
-      - name: Create tag if missing
-        id: tag
+      # 5. Optionally run tests
+      - name: Run tests
         run: |
-          # Configure Git user/email for tags
-          git config --global user.name "github-actions"
-          git config --global user.email "github-actions@github.com"
+          python -m pip install -e .[dev]
+          pytest tests
 
-          # Create tag only if it does not exist
-          if ! git rev-parse "v$VERSION" >/dev/null 2>&1; then
-            echo "Tag v$VERSION not found. Creating tag..."
-            git tag -a "v$VERSION" -m "Release v$VERSION"
-            git push origin "v$VERSION"
+      # 6. Create release & tag via GH CLI
+      - name: Create release (auto-tag)
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ env.VERSION }}
+        run: |
+          if gh release view "v$VERSION" >/dev/null 2>&1; then
+            echo "Release v$VERSION already exists."
           else
-            echo "Tag v$VERSION already exists."
+            echo "Creating release v$VERSION..."
+            gh release create "v$VERSION" \
+              --title "v$VERSION" \
+              --notes "Release v$VERSION" \
+              --draft=false
           fi
 
-      # 6. Build distributions
-      - name: Build package
+      # 7. Build source + wheel distributions
+      - name: Build distributions
         run: python -m build
 
-      # 7. Optionally, run tests before publishing
-      # - name: Run tests
-      #   run: |
-      #     python -m pip install -e .[dev]
-      #     pytest tests
-
       # 8. Publish to PyPI
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1