Patch v1.3.0 (#13)

* Revising compilation procedure

* Removing MD5 checkusum based verification

* Strengthening README.md file

* Adding additional compression methods and polishing I/O

* Improving coverage

* Updating docs

Author: ifilot

.github/workflows/build-openvdb.yml

@@ -8,52 +8,86 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Install dependencies
-      run: sudo apt install -y build-essential cmake libglm-dev libtclap-dev libboost-all-dev libopenvdb-dev libtbb-dev libcppunit-dev libeigen3-dev liblzma-dev zlib1g-dev libbz2-dev gcovr
-    - name: Configure CMake
-      run: mkdir build && cd build && cmake ../src -DUSE_GCOV=1
-    - name: Build
-      run: cd build && make -j
-    - name: Perform unit tests
-      run: cd build && make test
-    - name: Perform code coverage
-      run: |
-        cd build
-        gcovr -r ../ . --xml-pretty -e ".*\.h" > coverage.xml
-        gcovr -r ../ . --html -e ".*\.h" > report.html
-    - name: Upload coverage report
-      uses: actions/upload-artifact@v4
-      with:
-        name: code-coverage-report
-        path: ./build/report.html
-    - name: Upload coverage reports to Codecov
-      uses: codecov/codecov-action@v3
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        files: ./build/coverage.xml
-  
-  test-shared:
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y \
+            build-essential \
+            cmake \
+            libglm-dev \
+            libtclap-dev \
+            libboost-all-dev \
+            libopenvdb-dev \
+            libtbb-dev \
+            libcppunit-dev \
+            libeigen3-dev \
+            liblzma-dev \
+            zlib1g-dev \
+            libbz2-dev \
+            libzstd-dev \
+            libblosc-dev \
+            pkg-config \
+            gcovr
+      - name: Configure CMake
+        run: cmake -S src -B build -DUSE_GCOV=ON
+      - name: Build
+        run: cmake --build build --parallel
+      - name: Run unit tests
+        run: ctest --test-dir build --output-on-failure
+      - name: Collect coverage report
+        run: |
+          gcovr -r . build --xml-pretty -e ".*\\.h" > build/coverage.xml
+          gcovr -r . build --html -e ".*\\.h" > build/report.html
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: code-coverage-report
+          path: ./build/report.html
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./build/coverage.xml
 
+  test-shared:
     runs-on: ubuntu-latest
     needs: build
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Install dependencies
-      run: sudo apt install -y build-essential cmake libglm-dev libtclap-dev libboost-all-dev libopenvdb-dev libtbb-dev libcppunit-dev libeigen3-dev liblzma-dev zlib1g-dev libbz2-dev gcovr
-    - name: Configure CMake
-      run: mkdir build && cd build && cmake ../src
-    - name: Build
-      run: cd build && make -j && sudo make install
-    - name: Produce compilation using shared library
-      run: |
-        cd examples && mkdir build && cd build
-        cmake ../shared
-        make -j
-        ldd ./den2obj-shared-example
-        LD_LIBRARY_PATH=/usr/local/lib ./den2obj-shared-example
+      - uses: actions/checkout@v4
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y \
+            build-essential \
+            cmake \
+            libglm-dev \
+            libtclap-dev \
+            libboost-all-dev \
+            libopenvdb-dev \
+            libtbb-dev \
+            libcppunit-dev \
+            libeigen3-dev \
+            liblzma-dev \
+            zlib1g-dev \
+            libbz2-dev \
+            libzstd-dev \
+            libblosc-dev \
+            pkg-config \
+            gcovr
+      - name: Configure CMake
+        run: cmake -S src -B build
+      - name: Build and install
+        run: |
+          cmake --build build --parallel
+          sudo cmake --install build
+      - name: Produce compilation using shared library
+        run: |
+          cmake -S examples/shared -B examples/shared/build
+          cmake --build examples/shared/build --parallel
+          ldd examples/shared/build/den2obj-shared-example
+          LD_LIBRARY_PATH=/usr/local/lib ./examples/shared/build/den2obj-shared-example

.github/workflows/build.yml

@@ -9,21 +9,27 @@ on:
       - master
 
 permissions:
-  contents: write  # Grants write access to the repository contents
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
 
 jobs:
   build:
-    name: Build and Deploy Sphinx Documentation
+    name: Build Sphinx Documentation
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout Repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: 3.13.1
+        python-version: "3.13"
 
     - name: Install Dependencies
       run: |
@@ -34,13 +40,33 @@ jobs:
               sphinx_design \
               sphinx_subfigure \
               myst_parser
+
     - name: Build Documentation
       run: |
         cd docs
         make html
 
-    - name: Deploy to GitHub Pages
-      uses: peaceiris/actions-gh-pages@v3
+    - name: Configure GitHub Pages
+      if: github.event_name == 'push'
+      uses: actions/configure-pages@v5
+
+    - name: Upload GitHub Pages artifact
+      if: github.event_name == 'push'
+      uses: actions/upload-pages-artifact@v3
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/_build/html
+        path: docs/_build/html
+
+  deploy:
+    name: Deploy GitHub Pages
+    if: github.event_name == 'push'
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/docs.yml

@@ -27,7 +27,7 @@
 *.out
 *.app
 
-build/*
+build*/*
 CHGCAR*
 *.png
 src/config.h