Merge pull request #81 from JSchmie/cicd

Cicd

.github/workflows/pypi.yml

@@ -0,0 +1,101 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch_name:
+        description: 'Branch to build from (default is main)'
+        required: false
+        default: 'main'
+  workflow_run:
+    workflows: ["Run Tests"]  # Ensure this matches the name of your testing workflow
+    types:
+      - completed
+    branches: [main, develop]  # This ensures it only triggers for these branches
+
+env:
+  TestPyPI_URL: https://test.pypi.org/p/scraibe
+  PyPI_URL: https://pypi.org/p/scraibe
+  PyPI_DEV_URL: https://pypi.org/p/scraibe-nightly
+
+jobs:
+  
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    # Check if manually triggered or automatically after successful test
+    if: >
+      github.event_name == 'workflow_dispatch' ||
+      (github.event.workflow_run.conclusion == 'success' &&
+      (github.event.workflow_run.head_branch == 'main' || github.event.workflow_run.head_branch == 'develop'))
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.branch_name || github.event.workflow_run.head_branch }}
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Build source distribution
+        run: python3 setup.py sdist
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: $TestPyPI_URL
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  test-install:
+    name: Test Installation from TestPyPI
+    needs: publish-to-testpypi
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install package
+        run: |
+          python3 -m pip install --index-url $TestPyPI_URL
+
+  publish-to-pypi:
+    name: Conditional Publish to PyPI or Dev Repository
+    needs: [build, test-install]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: $PyPI_URL
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI or Dev Repository
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: ${{ github.ref == 'refs/heads/main' && 'env.PyPI_URL' || ' env.PyPI_DEV_URL' }}
+          password: ${{ secrets.PYPI_API_TOKEN}}
+
+

.github/workflows/pytest.yaml

@@ -1,11 +1,10 @@
-name: Run tests
+name: Run Tests
 
 on:
  #push:
   
   pull_request:
     branches: ['main', 'develop']
-
   workflow_dispatch:
 
 jobs:

.github/workflows/python-publish.yml

@@ -1,39 +0,0 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

.ruff.toml

@@ -0,0 +1,2 @@
+[lint.extend-per-file-ignores]
+"__init__.py" = ["E402","F403"]