Refactor CI workflow and enhance release process; add changelog for versioning

Author: vertok

.github/workflows/prismalog_ci.yml

@@ -313,11 +313,6 @@ jobs:
               </table>
             </div>
 
-            <div class="card">
-              <h2>Coverage Report</h2>
-              <p><a href="../htmlcov/index.html">HTML Coverage Report</a></p>
-            </div>
-
             <p class="timestamp">Generated: $(date -u "+%Y-%m-%d %H:%M:%S UTC")</p>
           </body>
           </html>
@@ -614,60 +609,61 @@ jobs:
           publish_dir: ./site
           keep_files: true
 
-  # publish:
-  #   needs: build
-  #   runs-on: ubuntu-latest
-  #   if: startsWith(github.ref, 'refs/tags/v')
-  #   steps:
-  #     - uses: actions/checkout@v3
-
-  #     - name: Set up Python
-  #       uses: actions/setup-python@v4
-  #       with:
-  #         python-version: '3.10'
-
-  #     - name: Install dependencies
-  #       run: |
-  #         python -m pip install --upgrade pip
-  #         pip install build twine
-
-  #     - name: Build package
-  #       run: python -m build
-
-  #     - name: Publish to PyPI
-  #       env:
-  #         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-  #         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-  #       run: twine upload dist/*
-
-  # create-release:
-  #   needs: publish
-  #   runs-on: ubuntu-latest
-  #   if: startsWith(github.ref, 'refs/tags/v')
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #       with:
-  #         fetch-depth: 0
-
-  #     - name: Generate release notes
-  #       id: release_notes
-  #       run: |
-  #         VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
-  #         echo "Generating release notes for $VERSION"
-
-  #         # Extract changelog entries for this version
-  #         NOTES=$(sed -n "/## \[$VERSION\]/,/## \[/p" CHANGELOG.md | sed '1d;$d')
-
-  #         # Format for GitHub release
-  #         echo "notes<<EOF" >> $GITHUB_OUTPUT
-  #         echo "$NOTES" >> $GITHUB_OUTPUT
-  #         echo "EOF" >> $GITHUB_OUTPUT
-
-  #     - name: Create GitHub Release
-  #       uses: softprops/action-gh-release@v1
-  #       with:
-  #         files: |
-  #           dist/*
-  #         body: ${{ steps.release_notes.outputs.notes }}
-  #       env:
-  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    environment: pypi-publish
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  create-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate release notes
+        id: release_notes
+        run: |
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          echo "Generating release notes for $VERSION"
+
+          # Extract changelog entries for this version
+          NOTES=$(sed -n "/## \[$VERSION\]/,/## \[/p" CHANGELOG.md | sed '1d;$d')
+
+          # Format for GitHub release
+          echo "notes<<EOF" >> $GITHUB_OUTPUT
+          echo "$NOTES" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/*
+          body: ${{ steps.release_notes.outputs.notes }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.readthedocs.yaml

@@ -10,19 +10,11 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - doc
 
 sphinx:
   configuration: docs/source/conf.py
 
 # Optionally build docs in additional format
 formats:
   - pdf
-
-# Install the package and its documentation dependencies
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - doc

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to `prismalog` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v0.1.0] - 2025-04-20
+- Initial release
+
+### Added
+- Initial release of `prismalog`
+- Core logging functionality with multi-process support
+- Configuration system with environment variable support
+- High-performance message queue implementation
+- Zero-dependency design for Python 3.8+
+- Comprehensive test suite with 90%+ code coverage
+- Full documentation and examples
+
+[v0.1.0]: https://github.com/vertok/prismalog/releases/tag/v0.1.0