Dynamic Version Integration in HTTP Headers with Release-Triggered Workflows (#96)

* Add dynamic version to HTTP headers
* Update auto-release.yml
* Optimize GitHub Actions setup for package release
* Update README.md
* update requirements

Author: bardabun

.github/workflows/auto-release.yml

@@ -1,23 +1,42 @@
-name: Pypi Release
+name: PyPI Release, Test, and Deploy
+
 on:
-  workflow_run:
-    workflows: [ "CI Tests" ]
-    branches: [ master ]
-    types:
-      - completed
-  # Allows you to run this workflow manually from the Actions tab
+  release:
+    types: [published]
+
 jobs:
+  ci-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run tox
+        run: python -m tox
+
   build-and-release:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    needs: ci-tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/[email protected]
         with:
           python-version: '3.x'
-      - name: "Install dependencies"
+      - name: Install dependencies
         run: |
-          python3 -m pip install setuptools wheel twine
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
       - name: "Build and uploads to PyPI"
         run: |
           python3 setup.py sdist bdist_wheel

.github/workflows/tests.yml

@@ -322,6 +322,10 @@ LOGGING = {
 
 ## Release Notes
 
+- 4.1.3
+    - Enhanced LogzioSender to dynamically set the user-agent header using the package version.
+    - Adjusted GitHub Actions to trigger on new releases.
+    - Streamlined versioning in deployments by automating Git tag extraction for PACKAGE_VERSION.
 - 4.1.2
     - Fix DeprecationWarning
     - Adjusted tests to logging:3.12

README.md

@@ -3,6 +3,7 @@
 import json
 import sys
 from datetime import datetime
+from importlib.metadata import version
 from threading import Thread, enumerate
 from time import sleep
 
@@ -14,7 +15,9 @@
     import Queue as queue
 else:
     import queue as queue
-
+PACKAGE_NAME = "logzio-python-handler"
+PACKAGE_VERSION = version(PACKAGE_NAME)
+SHIPPER_HEADER = {"user-agent": f"{PACKAGE_NAME}-version-{PACKAGE_VERSION}-logs"}
 MAX_BULK_SIZE_IN_BYTES = 1 * 1024 * 1024  # 1 MB
 
 
@@ -108,7 +111,7 @@ def _flush_queue(self):
             self.number_of_retries = self.number_of_retries
 
             should_backup_to_disk = True
-            headers = {"Content-type": "text/plain"}
+            headers = {"Content-type": "text/plain", **SHIPPER_HEADER}
 
             for current_try in range(self.number_of_retries):
                 should_retry = False

logzio/sender.py

@@ -2,3 +2,7 @@ requests>=2.27.0
 protobuf>=3.20.2
 setuptools>=68.0.0  # not directly required, pinned to avoid a vulnerability
 future>=0.18.3  # used in tests
+tox>=4.15.0
+wheel
+twine>=5.0.0
+setuptools_scm

requirements.txt

@@ -4,7 +4,7 @@
 
 setup(
     name="logzio-python-handler",
-    version='4.1.2',
+    use_scm_version=True,
     description="Logging handler to send logs to your Logz.io account with bulk SSL",
     keywords="logging handler logz.io bulk https",
     author="roiravhon",
@@ -23,6 +23,7 @@
     test_requires=[
         "future"
     ],
+    setup_requires=['setuptools_scm'],
     include_package_data=True,
     classifiers=[
         'Development Status :: 5 - Production/Stable',