ci: publish api docs and coverage as well

Also API coverage reports to both PRs and main documentation site. Signed-off-by: Anas Nashif <[email protected]>
YoeDistro · Oct 26, 2023 · bad87f1 · bad87f1
1 parent 51fee43
commit bad87f1
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -63,7 +63,7 @@ jobs:
     - name: install-pkgs
       run: |
         sudo apt-get update
-        sudo apt-get install -y ninja-build graphviz
+        sudo apt-get install -y ninja-build graphviz lcov
         wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
         tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
         echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
@@ -80,6 +80,7 @@ jobs:
         pip3 install -r doc/requirements.txt
         pip3 install west==${WEST_VERSION}
         pip3 install cmake==${CMAKE_VERSION}
+        pip3 install coverxygen
 
     - name: west setup
       run: |
@@ -99,28 +100,45 @@ jobs:
         else
           DOC_TARGET="html"
         fi
-
         DOC_TAG=${DOC_TAG} SPHINXOPTS_EXTRA="-q -t publish" make -C doc ${DOC_TARGET}
 
+        # API documentation coverage
+        python3 -m coverxygen --xml-dir  doc/_build/html/doxygen/xml/ --src-dir include/ --output doc-coverage.info
+        # deprecated page causing issues
+        lcov --remove doc-coverage.info \*/deprecated > new.info
+        genhtml --no-function-coverage --no-branch-coverage new.info -o coverage-report
+
     - name: compress-docs
       run: |
         tar cfJ html-output.tar.xz --directory=doc/_build html
+        tar cfJ api-output.tar.xz --directory=doc/_build html/doxygen/html
+        tar cfJ api-coverage.tar.xz coverage-report
 
     - name: upload-build
       uses: actions/upload-artifact@v3
       with:
         name: html-output
         path: html-output.tar.xz
 
+    - name: upload-api-coverage
+      uses: actions/upload-artifact@v3
+      with:
+        name: api-coverage
+        path: api-coverage.tar.xz
+
     - name: process-pr
       if: github.event_name == 'pull_request'
       run: |
         REPO_NAME="${{ github.event.repository.name }}"
         PR_NUM="${{ github.event.pull_request.number }}"
         DOC_URL="https://builds.zephyrproject.io/${REPO_NAME}/pr/${PR_NUM}/docs/"
+        API_DOC_URL="https://builds.zephyrproject.io/${REPO_NAME}/pr/${PR_NUM}/docs/doxygen/html/"
+        API_COVERAGE_URL="https://builds.zephyrproject.io/${REPO_NAME}/pr/${PR_NUM}/api-coverage/"
 
         echo "${PR_NUM}" > pr_num
         echo "Documentation will be available shortly at: ${DOC_URL}" >> $GITHUB_STEP_SUMMARY
+        echo "API Documentation will be available shortly at: ${API_DOC_URL}" >> $GITHUB_STEP_SUMMARY
+        echo "API Coverage Report will be available shortly at: ${API_COVERAGE_URL}" >> $GITHUB_STEP_SUMMARY
 
     - name: upload-pr-number
       uses: actions/upload-artifact@v3

diff --git a/.github/workflows/doc-publish-pr.yml b/.github/workflows/doc-publish-pr.yml
@@ -46,6 +46,7 @@ jobs:
     - name: Uncompress HTML docs
       run: |
         tar xf html-output/html-output.tar.xz -C html-output
+        tar xf api-coverage/api-coverage.tar.xz -C api-coverage
 
     - name: Configure AWS Credentials
       uses: aws-actions/configure-aws-credentials@v2
@@ -61,3 +62,6 @@ jobs:
         aws s3 sync --quiet html-output/html \
           s3://builds.zephyrproject.org/${{ github.event.repository.name }}/pr/${PR_NUM}/docs \
           --delete
+        aws s3 sync --quiet api-coverage/coverage-report/ \
+          s3://builds.zephyrproject.org/${{ github.event.repository.name }}/pr/${PR_NUM}/api-coverage \
+          --delete
diff --git a/.github/workflows/doc-publish.yml b/.github/workflows/doc-publish.yml
@@ -32,6 +32,7 @@ jobs:
     - name: Uncompress HTML docs
       run: |
         tar xf html-output/html-output.tar.xz -C html-output
+        tar xf api-coverage/api-coverage.tar.xz -C api-coverage
 
     - name: Configure AWS Credentials
       uses: aws-actions/configure-aws-credentials@v2
@@ -52,4 +53,5 @@ jobs:
 
         aws s3 sync --quiet html-output/html s3://docs.zephyrproject.org/${VERSION} --delete
         aws s3 sync --quiet html-output/html/doxygen/html s3://docs.zephyrproject.org/apidoc/${VERSION} --delete
+        aws s3 sync --quiet api-coverage/coverage-report/ s3://docs.zephyrproject.org/api-coverage/${VERSION} --delete
         aws s3 cp --quiet pdf-output/zephyr.pdf s3://docs.zephyrproject.org/${VERSION}/zephyr.pdf