Add joss-paper draft (#119)

* Add joss-paper draft

* Fix paper draft.

* Add missing orcid.

* Add first draft of the joss paper content.

* Update the JOSS paper

* Update cpp-python-tests.yml

Update action versions for python and checkout.

* Update cpp-python-tests-and-release.yml

Update actions to v3 for python and checkout.

* Update draft-joss-paper-pdf.yml

Update upload-artifact to latest version v3.

* Update the JOSS paper

* Update the JOSS paper

* Fix audio stream tests

* Fix audio stream tests

* Split the summary.

* Use BINARY directory to download assets. Will keep assets under the build directory.

* Fix Apple default BUILD set to Release

* Added documentation with Doxygen

* Added documentation with Doxygen

* Add missing documentation.

* Add JS types in doc comments

* Added API documentation with Doxygen

* Added API documentation with Doxygen

* Added release action with documentation

* Action on push

* Added OpenCV

* generate doc before building, optimize build target

* specify branch

* Remove make install, cleanup

* Avoid .gitignore in doc, use main .gitignore instead, fix python documentation link

* Update documentation link, re-arrange main README.md

* Added logo

* Audto corlor style

* Fix documentation file urls.

* Fix gen-doc-and-release.yml

* Revert changes

* Disable jekyll for GitHub Pages.

* Fix Doxygen docs.

* Setup gen-doc-and-release.yml for real releases.

* Update the JOSS paper.

* Remove telehealth management

* Add missing EOFs.

---------

Co-authored-by: Dominic Létourneau <doumdi@gmail.com>

.github/workflows/cpp-python-tests.yml

@@ -32,12 +32,12 @@ jobs:
             enable-gstreamer: ON
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
 

.github/workflows/draft-joss-paper-pdf.yml

@@ -0,0 +1,25 @@
+name: JOSS Paper Draft PDF
+
+on: [push]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: joss-paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v3
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: joss-paper/paper.pdf

.github/workflows/gen-doc-and-release.yml

@@ -0,0 +1,95 @@
+name: gen-doc-and-release
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+    branches: [main]
+
+
+jobs:
+  build-gen-doc-and-release:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Generate Version Output
+        id: generate_version_output
+        run: echo "version=$(cat VERSION)" >> $GITHUB_OUTPUT
+
+      - name: Print Version Information
+        run: echo "Version ${{ steps.generate_version_output.outputs.version }}"
+
+      - name: Install system dependencies (Linux)
+        run: |
+          sudo apt update
+          sudo apt install ninja-build cmake build-essential libssl-dev libboost-all-dev
+          sudo apt install libglib2.0-dev libgtk-3-dev libpulse-dev libasound2-dev tree perl
+          sudo apt install libopencv-dev
+          sudo apt install libunwind-dev
+          sudo apt install doxygen
+
+      - name: Install python dependencies
+        run: |
+          python -m pip install --user --upgrade pip
+          python -m pip install --user --upgrade setuptools wheel
+          python -m pip install --user --upgrade twine
+          python -m pip install --user --upgrade pytest
+          python -m pip install --user --upgrade sphinx
+          python -m pip install --user --upgrade pybind11-stubgen
+          python -m pip install --user --upgrade numpy
+          python -m pip install --user -r signaling-server/requirements.txt
+
+
+      - name: Generate C++ Documentation
+        working-directory: doc/cpp
+        run: |
+          export OPENTERA_WEBRTC_VERSION=${{ steps.generate_version_output.outputs.version }}
+          doxygen
+
+      - name: Generate JavaScript Documentation
+        working-directory: doc/js
+        run: |
+          export OPENTERA_WEBRTC_VERSION=${{ steps.generate_version_output.outputs.version }}
+          doxygen
+
+      - name: Create build directory
+        run: |
+          mkdir build
+
+      - name: Run CMake and build opentera-webrtc
+        working-directory: build
+        run: |
+          cmake ../ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=dist \
+          -DOPENTERA_WEBRTC_NATIVE_CLIENT_PYTHON_PIP_INSTALL_PREFIX='--user' \
+          -DOPENTERA_WEBRTC_NATIVE_CLIENT_PYTHON_VERSION="$(python3 --version | perl -pe 's/Python //')" \
+          -DOPENTERA_WEBRTC_USE_SYSTEM_OPENCV=ON
+          make -j2 native_client-html-target
+
+      - name: Copy Python Documentation to Doc Folder
+        run: |
+          mkdir -p doc/python
+          cp -r build/opentera-webrtc-native-client/OpenteraWebrtcNativeClient/python/package/opentera_webrtc_native_client/_build/* doc/python
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@3.7.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: doc
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: v${{ steps.generate_version_output.outputs.version }}
+          release_name: opentera-webrtc-native-client-${{ steps.generate_version_output.outputs.version }}
+          body: |
+            Latest build of opentera-webrtc-native-client v${{ steps.generate_version_output.outputs.version }}
+            - Please see API documentation at https://introlab.github.io/opentera-webrtc
+          draft: false
+          prerelease: false

.gitignore

@@ -3,3 +3,5 @@ build
 cmake-build-*
 compile_commands.json
 .gdbinit
+doc/cpp/html
+doc/js/html

CMakeLists.txt

@@ -27,8 +27,8 @@ endif (POLICY CMP0094)
 
 project(opentera-webrtc)
 
-if (NOT DEFINED CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Release CACHE STRING "")
+if (NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
 endif ()
 
 # Python version