Rework workflow, remove obsolete python files

Signed-off-by: Pierre R. Mai <pmai@pmsf.de>

Author: pmai

.github/workflows/protobuf.yml

@@ -1,10 +1,5 @@
 name: ProtoBuf CI Builds
 
-env:
-  PROTOBUF_VERSION: 3.20.1
-  PROTOBUF_VARIANT: '-all' # Use '-all' prior to 22.0, '' after
-  ABSEIL_VERSION: 20230802.1
-
 on:
   push:
   pull_request:
@@ -21,8 +16,8 @@ jobs:
       with:
         config_path: .github/.pyspelling.yml
 
-  build-proto2-linux64:
-    name: Build Proto2 Linux 64
+  run-tests:
+    name: Run tests and build docs
 
     runs-on: ubuntu-22.04
 
@@ -32,11 +27,6 @@ jobs:
       with:
         submodules: true
 
-    - name: Check Build Setup
-      run: |
-        ( result=0 ; for f in *.proto ; do grep -wq "$f" CMakeLists.txt || { echo "Missing $f in CMakeLists.txt" && let "result++"; } ; done ; exit $result )
-        ( result=0 ; for f in *.proto ; do grep -q '"'$f'"' setup.py || { echo "Missing $f in setup.py" && let "result++"; } ; done ; exit $result )
-
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
@@ -45,49 +35,15 @@ jobs:
     - name: Install Python Dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install build
         python -m pip install -r requirements_tests.txt
 
-    - name: Check black format
-      run: |
-        black --check --diff .
-
     - name: Install Doxygen
       run: sudo apt-get install doxygen graphviz
 
-    - name: Cache Dependencies
-      id: cache-depends
-      uses: actions/cache@v4
-      with:
-        path: protobuf-${{ env.PROTOBUF_VERSION }}
-        key: ${{ runner.os }}-v2-depends
-
-    - name: Download ProtoBuf ${{ env.PROTOBUF_VERSION }}
-      if: steps.cache-depends.outputs.cache-hit != 'true'
-      run: curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v${{env.PROTOBUF_VERSION}}/protobuf${{env.PROTOBUF_VARIANT}}-${{env.PROTOBUF_VERSION}}.tar.gz && tar xzvf protobuf${{env.PROTOBUF_VARIANT}}-${{env.PROTOBUF_VERSION}}.tar.gz
-
-    - name: Download Abseil ${{ env.ABSEIL_VERSION }}
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == ''
-      run: curl -OL https://github.com/abseil/abseil-cpp/archive/refs/tags/${{env.ABSEIL_VERSION}}.tar.gz && tar xzvf ${{env.ABSEIL_VERSION}}.tar.gz && rm -rf protobuf-${{env.PROTOBUF_VERSION}}/third_party/abseil-cpp && mv abseil-cpp-${{env.ABSEIL_VERSION}} protobuf-${{env.PROTOBUF_VERSION}}/third_party/abseil-cpp
-
-    - name: Build ProtoBuf ${{ env.PROTOBUF_VERSION }} via autotools
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == '-all'
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: ./configure DIST_LANG=cpp --prefix=/usr && make
-
-    - name: Build ProtoBuf ${{ env.PROTOBUF_VERSION }} via cmake
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == ''
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: cmake -DCMAKE_CXX_STANDARD=17 -Dprotobuf_BUILD_SHARED_LIBS=ON -Dprotobuf_BUILD_TESTS=OFF . && cmake --build . --config Release -j 4
-
-    - name: Install ProtoBuf ${{ env.PROTOBUF_VERSION }}
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: sudo make install && sudo ldconfig
-
     - name: Install proto2cpp
       run: git clone --depth 1 https://github.com/OpenSimulationInterface/proto2cpp.git
 
-    - name: Prepare C++ Build
+    - name: Prepare Build
       run: mkdir build
 
     - name: Add Development Version Suffix
@@ -105,136 +61,19 @@ jobs:
         echo "EXCLUDE_PATTERNS = */osi3/* */protobuf-*/* */proto2cpp/* */flatbuffers/*" >> doxygen_config.cmake.in
         echo "GENERATE_TREEVIEW = YES" >> doxygen_config.cmake.in
 
-    - name: Configure C++ Build
+    - name: Configure Build
       working-directory: build
-      run: cmake -D FILTER_PROTO2CPP_PY_PATH=$GITHUB_WORKSPACE/proto2cpp ${{ env.PROTOBUF_VARIANT =='' && '-DCMAKE_CXX_STANDARD=17' }} ..
+      run: cmake -D FILTER_PROTO2CPP_PY_PATH=$GITHUB_WORKSPACE/proto2cpp ..
 
-    - name: Build C++
+    - name: Build
       working-directory: build
       run: cmake --build . --config Release -j 4
 
-    - name: Build Python
-      run: python -m build
-
-    - name: Install Python
-      run: python -m pip install .
-
     - name: Run Python Tests
       run: python -m unittest discover tests
 
-    - name: Upload Python Distribution
-      if: ${{ github.event_name == 'pull_request' || ( github.event_name == 'push' && ( github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v') ) ) }}
+    - name: Upload documentation
       uses: actions/upload-artifact@v4
       with:
-        name: python-dist
-        path: dist/
-
-  build-proto3-linux64:
-    name: Build Proto3 Linux 64
-
-    runs-on: ubuntu-22.04
-
-    steps:
-    - name: Checkout OSI
-      uses: actions/checkout@v4
-      with:
-        submodules: true
-
-    - name: Setup Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.8'
-
-    - name: Install Python Dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install build
-        python -m pip install -r requirements_tests.txt
-
-    - name: Cache Dependencies
-      id: cache-depends
-      uses: actions/cache@v4
-      with:
-        path: protobuf-${{ env.PROTOBUF_VERSION }}
-        key: ${{ runner.os }}-v2-depends
-
-    - name: Download ProtoBuf ${{ env.PROTOBUF_VERSION }}
-      if: steps.cache-depends.outputs.cache-hit != 'true'
-      run: curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v${{env.PROTOBUF_VERSION}}/protobuf${{env.PROTOBUF_VARIANT}}-${{env.PROTOBUF_VERSION}}.tar.gz && tar xzvf protobuf${{env.PROTOBUF_VARIANT}}-${{env.PROTOBUF_VERSION}}.tar.gz
-
-    - name: Download Abseil ${{ env.ABSEIL_VERSION }}
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == ''
-      run: curl -OL https://github.com/abseil/abseil-cpp/archive/refs/tags/${{env.ABSEIL_VERSION}}.tar.gz && tar xzvf ${{env.ABSEIL_VERSION}}.tar.gz && rm -rf protobuf-${{env.PROTOBUF_VERSION}}/third_party/abseil-cpp && mv abseil-cpp-${{env.ABSEIL_VERSION}} protobuf-${{env.PROTOBUF_VERSION}}/third_party/abseil-cpp
-
-    - name: Build ProtoBuf ${{ env.PROTOBUF_VERSION }} via autotools
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == '-all'
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: ./configure DIST_LANG=cpp --prefix=/usr && make
-
-    - name: Build ProtoBuf ${{ env.PROTOBUF_VERSION }} via cmake
-      if: steps.cache-depends.outputs.cache-hit != 'true' && env.PROTOBUF_VARIANT == ''
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: cmake -DCMAKE_CXX_STANDARD=17 -Dprotobuf_BUILD_SHARED_LIBS=ON -Dprotobuf_BUILD_TESTS=OFF . && cmake --build . --config Release -j 4
-
-    - name: Install ProtoBuf ${{ env.PROTOBUF_VERSION }}
-      working-directory: protobuf-${{ env.PROTOBUF_VERSION }}
-      run: sudo make install && sudo ldconfig
-
-    - name: Prepare C++ Build
-      run: mkdir build
-
-    - name: Switch to Proto3 Syntax
-      run: |
-        bash convert-to-proto3.sh
-        rm *.pb2
-
-    - name: Add Development Version Suffix
-      if: ${{ !startsWith(github.ref, 'refs/tags') }}
-      run: |
-        echo "VERSION_SUFFIX = .dev`date -u '+%Y%m%d%H%M%S'`" >> VERSION
-
-    - name: Configure C++ Build
-      working-directory: build
-      run: cmake ${{ env.PROTOBUF_VARIANT =='' && '-DCMAKE_CXX_STANDARD=17' }} ..
-
-    - name: Build C++
-      working-directory: build
-      run: cmake --build . --config Release -j 4
-
-    - name: Build Python
-      run: python -m build
-
-    - name: Install Python
-      run: python -m pip install .
-
-    - name: Run Python Tests
-      run: python -m unittest discover tests
-
-  publish-python-dist:
-    name: Publish Python Distribution
-
-    runs-on: ubuntu-22.04
-
-    permissions:
-      id-token: write
-
-    needs: [build-proto2-linux64, build-proto3-linux64]
-
-    if: ${{ github.event_name == 'push' && ( github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v') ) }}
-
-    steps:
-    - name: Download Distribution
-      uses: actions/download-artifact@v4
-      with:
-        name: python-dist
-        path: dist/
-
-    - name: Publish Snapshot Release on TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      continue-on-error: true
-      with:
-        repository-url: https://test.pypi.org/legacy/
-
-    - name: Publish Full Release on PyPI
-      if: startsWith(github.ref, 'refs/tags/v') && ( ! contains(github.ref, '-') )
-      uses: pypa/gh-action-pypi-publish@release/v1
+        name: doxygen-doc
+        path: doc/

CMakeLists.txt

@@ -0,0 +1,33 @@
+cmake_minimum_required(VERSION 3.10)
+
+project(open_simulation_interface_doc)
+
+# read the version number from the file "VERSION"
+file(STRINGS "VERSION" VERSION_CONTENTS)
+foreach(LINE ${VERSION_CONTENTS})
+  string(REGEX REPLACE " |\t" "" LINE ${LINE})
+  string(REGEX MATCH "^[^=]+" VERSION_NAME ${LINE})
+  string(REPLACE "${VERSION_NAME}=" "" VERSION_VALUE ${LINE})
+  set(${VERSION_NAME} "${VERSION_VALUE}")
+endforeach()
+
+configure_file(osi_version.proto.in osi_version.proto)
+
+# add a target to generate API documentation with Doxygen
+# Dependencies: Doxygen and proto2cpp.py
+find_package(Doxygen)
+if(Doxygen_FOUND)
+  set(FILTER_PROTO2CPP_PY_PATH CACHE PATH "directory to the filter proto2cpp.py")
+  if(NOT EXISTS ${FILTER_PROTO2CPP_PY_PATH}/proto2cpp.py)
+    message(WARNING "${FILTER_PROTO2CPP_PY_PATH}/proto2cpp.py could not be found.")
+  else()
+    set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/doxygen_config.cmake.in)
+    set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+    configure_file(${doxyfile_in} ${doxyfile} @ONLY)
+
+    add_custom_target(api_doc ALL
+      COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+  endif()
+endif()