Fix outdated documentation on formatting scripts #1558
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | |
| branches: [ master ] | |
| jobs: | |
| spellcheck: | |
| name: Spellcheck | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: rojopolis/spellcheck-github-actions@0.36.0 | |
| name: Spellcheck | |
| with: | |
| config_path: .github/.pyspelling.yml | |
| build-proto2-linux64: | |
| name: Build Proto2 Linux 64 | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout OSI | |
| uses: actions/checkout@v4 | |
| 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: | |
| 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: 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 | |
| run: mkdir build | |
| - 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: Get git Version | |
| id: get_version | |
| run: echo "VERSION=$(git describe --tags --always)" >> $GITHUB_OUTPUT | |
| - name: Prepare Documentation Build | |
| run: | | |
| sed -i 's/PROJECT_NUMBER\s*= @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@/PROJECT_NUMBER = master (${{ steps.get_version.outputs.VERSION }})/g' doxygen_config.cmake.in | |
| echo "EXCLUDE_PATTERNS = */osi3/* */protobuf-*/* */proto2cpp/* */flatbuffers/*" >> doxygen_config.cmake.in | |
| echo "GENERATE_TREEVIEW = YES" >> doxygen_config.cmake.in | |
| - name: Configure C++ Build | |
| working-directory: build | |
| run: cmake -D FILTER_PROTO2CPP_PY_PATH=$GITHUB_WORKSPACE/proto2cpp ${{ 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 | |
| - name: Archive Documentation | |
| if: ${{ github.event_name == 'pull_request' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: linux64-doc | |
| path: doc/html | |
| if-no-files-found: error | |
| - name: Upload Python Distribution | |
| if: ${{ github.event_name == 'pull_request' || ( github.event_name == 'push' && github.ref == 'refs/heads/master' ) }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: python-dist | |
| path: dist/ | |
| - name: Deploy to gh-pages if push to master branch | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./doc/html | |
| 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' }} | |
| 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 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ |