Skip to content

Commit

Permalink
Update doxygen workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Iandiehard committed Oct 2, 2023
1 parent ccf1283 commit 249591c
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 10 deletions.
40 changes: 31 additions & 9 deletions .github/workflows/doxygen-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
name: Doxygen GitHub Pages Deploy Action
name: Doxygen Action

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
workflow_dispatch:

env:
# Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
BUILD_TYPE: Debug

jobs:
deploy:
build:
runs-on: ubuntu-latest
steps:
- uses: DenverCoder1/doxygen-github-pages-action@v1.3.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
config_file: docs/Doxyfile
- uses: actions/checkout@v2
- name: Check Dir
run: ls docs/
#- name: Doxygen Action
# uses: mattnotmitt/doxygen-action@v1.9.5
# with:
# working-directory: "."
# doxyfile-path: "docs/Doxyfile"

- name: Configure CMake
run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DBUILD_DIAG_CLIENT:BOOL=OFF -DBUILD_DOXYGEN:BOOL=ON -DCMAKE_TOOLCHAIN_FILE=toolchains/linux_gcc_9.cmake

- name: Build
# Build your program with the given configuration
run: |
sudo apt-get install doxygen
cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
ls ${{github.workspace}}/build/
ls ${{github.workspace}}/build/docs/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./generated-docs/html
1 change: 0 additions & 1 deletion .github/workflows/gcc9_with_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ jobs:
export DLT_LOCAL_PRINT_MODE=FORCE_ON
export DLT_INITIAL_LOG_LEVEL="::6"
./gtest-diag-client-lib --gtest_output="xml:test-report.xml"
ls .
- name: Archive test results
uses: actions/upload-artifact@v3
Expand Down
3 changes: 3 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ cmake_minimum_required(VERSION 3.5)
project(diag-client)

# Cmake options
option(BUILD_DIAG_CLIENT "Option to use Dlt for logging" ON)
option(BUILD_SHARED_LIBS "Option to build as shared library" OFF)
option(BUILD_WITH_DLT "Option to use Dlt for logging" OFF)
option(BUILD_DOXYGEN "Option to generate doxygen file" OFF)
Expand All @@ -24,7 +25,9 @@ if (BUILD_WITH_DLT)
endif (BUILD_WITH_DLT)

# Build diag-client library
if (BUILD_DIAG_CLIENT)
add_subdirectory(diag-client-lib)
endif (BUILD_DIAG_CLIENT)

# Build diag-client doxygen documentation
if (BUILD_DOXYGEN)
Expand Down

0 comments on commit 249591c

Please sign in to comment.