Merge branch 'eclipse-velocitas:main' into erik_doc

eclipse-velocitas · Sep 6, 2024 · dfcf5f7 · dfcf5f7
2 parents db3f2cb + bb166e5
commit dfcf5f7
Show file tree

Hide file tree

Showing 14 changed files with 260 additions and 200 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,4 +1,4 @@
-# Copyright (c) 2022-2024 Contributors to the Eclipse Foundation
+# Copyright (c) 2024 Contributors to the Eclipse Foundation
 #
 # This program and the accompanying materials are made available under the
 # terms of the Apache License, Version 2.0 which is available at
@@ -12,56 +12,92 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-name: Release workflow
+name: Github Release and PyPi Publish
 
 on:
-  release:
-    types: [published, edited]
+  workflow_dispatch:
+  push:
+   tags:
+     - "v*.*.*"
 
 jobs:
-  release-package:
-    name: Generate package binaries
-    runs-on: ubuntu-latest
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-22.04
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - name: Install pypa/build
+      run: pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: |
+          dist/
+          LICENSE
+          NOTICE.md
 
-      - name: Initialize python
-        uses: actions/setup-python@v5
-        with:
-            python-version: "3.10"
+  publish-to-pypi:
+    name: Publish 🐍 to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-22.04
+    environment:
+      name: pypi
+      url: https://pypi.org/p/velocitas-sdk
 
-      - name: Install Dependencies
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements.txt
+    permissions:
+      id-token: write
 
-      - name: Set tags output
-        id: vars
-        run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
-
-      - name: Check output
-        env:
-          RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
-        run: |
-          echo $RELEASE_VERSION
-          echo ${{ steps.vars.outputs.tag }}
+    steps:
+    - name: Download dists folder
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: python-package/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        packages-dir: python-package/dist
 
-      - name: Test setup.cfg execution
-        run: |
-          sed -i -e 's/@tag/${{ steps.vars.outputs.tag }}/g' ./setup.py
-          python3 setup.py sdist
+  github-release:
+    name: >-
+      Create GitHub Release
+    needs:
+    - build
+    runs-on: ubuntu-22.04
 
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: release
-          path: ./dist
+    permissions:
+      contents: write
+      id-token: write
 
-      - name: Upload assets
-        uses: softprops/action-gh-release@v1
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          files: |
-            ./dist/*
+    steps:
+    - name: Download dists folder
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: python-package/
+    - name: Sign the dists with Sigstore
+      # If running on your own fork/organization
+      # you must assure that sigstore has been added as authroized OAuth app in Github
+      # Can be triggered by a manual run on CLI like "sigstore sign <somefile>"
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./python-package/dist/*.tar.gz
+          ./python-package/dist/*.whl
+    - name: Create release
+      id: create_release
+      uses: softprops/action-gh-release@v2
+      with:
+        files: |
+          python-package/dist/**
+          python-package/LICENSE
+          python-package/NOTICE.md
diff --git a/.project-creation/.skeleton/requirements.in b/.project-creation/.skeleton/requirements.in
@@ -12,7 +12,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-grpcio==1.59.0
-protobuf==4.24.4
-cloudevents==1.10.0
-aiohttp==3.9.3
+grpcio==1.64.1
+protobuf==5.27.2
+cloudevents==1.11.0
+aiohttp==3.10.5
diff --git a/.project-creation/.skeleton/requirements.txt b/.project-creation/.skeleton/requirements.txt
@@ -4,33 +4,35 @@
 #
 #    pip-compile
 #
-aiohttp==3.9.3
+aiohappyeyeballs==2.4.0
+    # via aiohttp
+aiohttp==3.10.5
     # via -r requirements.in
 aiosignal==1.3.1
     # via aiohttp
 async-timeout==4.0.3
     # via aiohttp
-attrs==23.1.0
+attrs==24.2.0
     # via aiohttp
-cloudevents==1.10.0
+cloudevents==1.11.0
     # via -r requirements.in
 deprecation==2.1.0
     # via cloudevents
-frozenlist==1.4.0
+frozenlist==1.4.1
     # via
     #   aiohttp
     #   aiosignal
-grpcio==1.59.0
+grpcio==1.64.1
     # via -r requirements.in
-idna==3.4
+idna==3.8
     # via yarl
-multidict==6.0.4
+multidict==6.0.5
     # via
     #   aiohttp
     #   yarl
-packaging==23.2
+packaging==24.1
     # via deprecation
-protobuf==4.24.4
+protobuf==5.27.2
     # via -r requirements.in
-yarl==1.9.2
+yarl==1.9.7
     # via aiohttp
diff --git a/NOTICE-3RD-PARTY-CONTENT.md b/NOTICE-3RD-PARTY-CONTENT.md
@@ -3,74 +3,78 @@
 ## Python
 | Dependency | Version | License |
 |:-----------|:-------:|--------:|
-|aiohttp|3.9.3|Apache 2.0|
+|aiohappyeyeballs|2.4.0|Other/Proprietary License<br/>Python Software Foundation License|
+|aiohttp|3.10.5|Apache 2.0|
 |aiosignal|1.3.1|Apache 2.0|
 |APScheduler|3.10.4|MIT|
 |async-timeout|4.0.3|Apache 2.0|
-|attrs|23.1.0|MIT|
-|build|1.0.3|MIT|
-|cachetools|5.3.2|MIT|
+|attrs|24.2.0|MIT|
+|build|1.2.1|MIT|
+|cachetools|5.5.0|MIT|
 |cfgv|3.4.0|MIT|
 |chardet|5.2.0|LGPL|
 |click|8.1.7|New BSD|
-|cloudevents|1.10.1|Apache 2.0|
+|cloudevents|1.11.0|Apache 2.0|
 |colorama|0.4.6|BSD|
-|coverage|7.4.1|Apache 2.0|
+|coverage|7.6.1|Apache 2.0|
 |Deprecated|1.2.14|MIT|
 |deprecation|2.1.0|Apache 2.0|
 |distlib|0.3.8|Python Software Foundation License|
-|exceptiongroup|1.2.0|MIT|
-|filelock|3.13.1|The Unlicense (Unlicense)|
-|frozenlist|1.4.0|Apache 2.0|
+|exceptiongroup|1.2.2|MIT|
+|filelock|3.15.4|The Unlicense (Unlicense)|
+|frozenlist|1.4.1|Apache 2.0|
 |grpc-stubs|1.53.0.5|MIT|
-|grpcio|1.59.0|Apache 2.0|
-|grpcio-tools|1.59.0|Apache 2.0|
-|identify|2.5.33|MIT|
-|idna|3.4|BSD|
+|grpcio|1.64.1|Apache 2.0|
+|grpcio-tools|1.64.1|Apache 2.0|
+|identify|2.6.0|MIT|
+|idna|3.8|BSD|
+|importlib-metadata|7.1.0|Apache 2.0|
 |iniconfig|2.0.0|MIT|
-|multidict|6.0.4|Apache 2.0|
-|mypy|1.8.0|MIT|
+|multidict|6.0.5|Apache 2.0|
+|mypy|1.11.2|MIT|
 |mypy-extensions|1.0.0|MIT|
-|mypy-protobuf|3.4.0|Apache 2.0|
-|nodeenv|1.8.0|BSD|
-|opentelemetry-api|1.15.0|Apache 2.0|
-|opentelemetry-distro|0.36b0|Apache 2.0|
-|opentelemetry-instrumentation|0.36b0|Apache 2.0|
-|opentelemetry-instrumentation-logging|0.36b0|Apache 2.0|
-|opentelemetry-sdk|1.15.0|Apache 2.0|
-|opentelemetry-semantic-conventions|0.36b0|Apache 2.0|
-|packaging|23.1|Apache 2.0<br/>BSD|
-|paho-mqtt|1.6.1|OSI Approved|
+|mypy-protobuf|3.6.0|Apache 2.0|
+|nodeenv|1.9.1|BSD|
+|opentelemetry-api|1.25.0|Apache 2.0|
+|opentelemetry-distro|0.46b0|Apache 2.0|
+|opentelemetry-instrumentation|0.46b0|Apache 2.0|
+|opentelemetry-instrumentation-logging|0.46b0|Apache 2.0|
+|opentelemetry-sdk|1.25.0|Apache 2.0|
+|opentelemetry-semantic-conventions|0.46b0|Apache 2.0|
+|packaging|24.1|Apache 2.0<br/>BSD|
+|paho-mqtt|2.1.0|OSI Approved|
 |pip|23.0.1|MIT|
-|pip-tools|7.3.0|BSD|
-|platformdirs|4.2.0|MIT|
-|pluggy|1.4.0|MIT|
-|pre-commit|3.6.0|MIT|
-|protobuf|4.21.12|Google License|
-|pyproject-api|1.6.1|MIT|
-|pyproject-hooks|1.0.0|MIT|
-|pytest|7.4.4|MIT|
-|pytest-asyncio|0.23.4|Apache 2.0|
-|pytest-cov|4.1.0|MIT|
+|pip-tools|7.4.1|BSD|
+|platformdirs|4.2.2|MIT|
+|pluggy|1.5.0|MIT|
+|pre-commit|3.8.0|MIT|
+|protobuf|5.27.2|Google License|
+|pyproject-api|1.7.1|MIT|
+|pyproject-hooks|1.1.0|MIT|
+|pytest|8.3.2|MIT|
+|pytest-asyncio|0.24.0|Apache 2.0|
+|pytest-cov|5.0.0|MIT|
 |pytz|2024.1|MIT|
-|PyYAML|6.0.1|MIT|
+|PyYAML|6.0.2|MIT|
 |setuptools|65.5.1|MIT|
 |six|1.16.0|MIT|
 |tomli|2.0.1|MIT|
-|tox|4.11.4|MIT|
-|types-Deprecated|1.2.9.20240106|Apache 2.0|
-|types-mock|5.1.0.20240106|Apache 2.0|
-|types-protobuf|4.24.0.20240129|Apache 2.0|
-|typing-extensions|4.7.1|Python Software Foundation License|
+|tox|4.18.0|MIT|
+|types-Deprecated|1.2.9.20240311|Apache 2.0|
+|types-mock|5.1.0.20240425|Apache 2.0|
+|types-protobuf|5.27.0.20240626|Apache 2.0|
+|typing-extensions|4.12.2|Python Software Foundation License|
 |tzlocal|5.2|MIT|
-|virtualenv|20.25.0|MIT|
-|wheel|0.42.0|MIT|
-|wrapt|1.15.0|BSD|
-|yarl|1.9.2|Apache 2.0|
+|virtualenv|20.26.3|MIT|
+|wheel|0.44.0|MIT|
+|wrapt|1.16.0|BSD|
+|yarl|1.9.7|Apache 2.0|
+|zipp|3.20.1|MIT|
 ## Workflows
 | Dependency | Version | License |
 |:-----------|:-------:|--------:|
 |actions/checkout|v4|MIT License|
+|actions/download-artifact|v4|MIT License|
 |actions/setup-java|v4|MIT License|
 |actions/setup-node|v4|MIT License|
 |actions/setup-python|v5|MIT License|
@@ -80,4 +84,6 @@
 |github/codeql-action|v3|MIT License|
 |mikepenz/action-junit-report|v4|Apache License 2.0|
 |pre-commit/action|v3.0.1|MIT License|
-|softprops/action-gh-release|v1|MIT License|
+|pypa/gh-action-pypi-publish|release/v1|BSD 3-Clause "New" or "Revised" License|
+|sigstore/gh-action-sigstore-python|v3.0.0|Apache License 2.0|
+|softprops/action-gh-release|v2|MIT License|
diff --git a/examples/seat-adjuster/requirements.in b/examples/seat-adjuster/requirements.in
@@ -12,8 +12,8 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-grpcio==1.59.0
-protobuf==4.24.4
-cloudevents==1.10.0
-aiohttp==3.9.3
-packaging==23.0
+grpcio==1.64.1
+protobuf==5.27.2
+cloudevents==1.11.0
+aiohttp==3.10.5
+packaging==24.1
diff --git a/examples/seat-adjuster/requirements.txt b/examples/seat-adjuster/requirements.txt
@@ -4,35 +4,37 @@
 #
 #    pip-compile
 #
-aiohttp==3.9.3
+aiohappyeyeballs==2.4.0
+    # via aiohttp
+aiohttp==3.10.5
     # via -r requirements.in
 aiosignal==1.3.1
     # via aiohttp
 async-timeout==4.0.3
     # via aiohttp
-attrs==23.1.0
+attrs==24.2.0
     # via aiohttp
-cloudevents==1.10.0
+cloudevents==1.11.0
     # via -r requirements.in
 deprecation==2.1.0
     # via cloudevents
-frozenlist==1.4.0
+frozenlist==1.4.1
     # via
     #   aiohttp
     #   aiosignal
-grpcio==1.59.0
+grpcio==1.64.1
     # via -r requirements.in
-idna==3.4
+idna==3.8
     # via yarl
-multidict==6.0.4
+multidict==6.0.5
     # via
     #   aiohttp
     #   yarl
-packaging==23.0
+packaging==24.1
     # via
     #   -r requirements.in
     #   deprecation
-protobuf==4.24.4
+protobuf==5.27.2
     # via -r requirements.in
-yarl==1.9.2
+yarl==1.9.7
     # via aiohttp
diff --git a/examples/seat-adjuster/tests/requirements.in b/examples/seat-adjuster/tests/requirements.in
@@ -17,4 +17,3 @@ pytest-ordering
 pytest-asyncio
 pytest-cov
 types-mock
-packaging==23.0