🎨 describe and format cicd GitHub Action

Author: enryH

.github/workflows/README.md

@@ -0,0 +1,11 @@
+# Workflows
+
+## cicd
+
+Basic continuous integration and deployment (CI/CD) workflow for Python packages.
+
+- checks formatting (black)
+- checks linting (ruff)
+- run unit tests (pytest)
+- optional: add c extensions to a package
+- if all checks pass, build and deploy to PyPI if `tag` triggered the workflow

.github/workflows/cicd.yml

@@ -6,20 +6,19 @@ name: Python application
 on:
   push:
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
   schedule:
-    - cron: '0 2 * * 3'
+    - cron: "0 2 * * 3"
 
 permissions:
   contents: read
 
-
 jobs:
   format:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: psf/black@stable 
+      - uses: psf/black@stable
   lint:
     name: Lint with ruff
     runs-on: ubuntu-latest
@@ -30,9 +29,9 @@ jobs:
         with:
           python-version: "3.11"
       - name: Install ruff
-        run: | 
+        run: |
           pip install ruff
-      - name: Lint with ruff  
+      - name: Lint with ruff
         run: |
           # stop the build if there are Python syntax errors or undefined names
           ruff check .
@@ -48,36 +47,36 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip' # caching pip dependencies
-          cache-dependency-path: '**/pyproject.toml'
+          cache: "pip" # caching pip dependencies
+          cache-dependency-path: "**/pyproject.toml"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install pytest
           pip install -e .
       - name: Run tests
         run: python -m pytest tests
-  
+
   build_source_dist:
     name: Build source distribution
     if: startsWith(github.ref, 'refs/heads/main') || startsWith(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:
-        - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-        - uses: actions/setup-python@v5
-          with:
-            python-version: "3.10"
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
 
-        - name: Install build
-          run: python -m pip install build
+      - name: Install build
+        run: python -m pip install build
 
-        - name: Run build
-          run: python -m build --sdist
+      - name: Run build
+        run: python -m build --sdist
 
-        - uses: actions/upload-artifact@v4
-          with:
-            path: ./dist/*.tar.gz
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ./dist/*.tar.gz
   # Needed in case of building packages with external binaries (e.g. Cython, RUst-extensions, etc.)
   # build_wheels:
   #   name: Build wheels on ${{ matrix.os }}
@@ -105,25 +104,25 @@ jobs:
   #           path: ./wheels/*.whl
 
   publish:
-      name: Publish package
-      if: startsWith(github.ref, 'refs/tags')
-      needs:
-          - format
-          - lint
-          - test
-          - build_source_dist
-          # - build_wheels
-      runs-on: ubuntu-latest
-
-      steps:
-          - uses: actions/download-artifact@v4
-            with:
-              name: artifact
-              path: ./dist
-
-          - uses: pypa/gh-action-pypi-publish@release/v1
-            with:
-              # remove repository key to set the default to pypi (not test.pypi.org) 
-              repository-url: https://test.pypi.org/legacy/
-              user: __token__
-              password: ${{ secrets.PYPI_API_TOKEN }}
+    name: Publish package
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - format
+      - lint
+      - test
+      - build_source_dist
+      # - build_wheels
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: artifact
+          path: ./dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # remove repository key to set the default to pypi (not test.pypi.org)
+          repository-url: https://test.pypi.org/legacy/
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}