doxygen.yml

# Author: Kang Lin<kl222@126.com>

name: Doxygen

on:
  workflow_call:
    outputs:
      name:
        description: "The artifact name"
        value: ${{ jobs.build_doxygen.outputs.name }}

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  build_doxygen:
    runs-on: ubuntu-latest
    env:
      BUILD_TYPE:  Release
      SOURCE_DIR:  ${{github.workspace}}/.cache/source
      TOOLS_DIR:   ${{github.workspace}}/.cache/tools
      INSTALL_DIR: ${{github.workspace}}/.cache/install_ubuntu
      DOXYGEN_VERSION: 1.9.8
      artifact_name: build_doxygen
      RabbitRemoteControl_VERSION: v0.1.0-dev

    # Map the job outputs to step outputs
    outputs:
      name: ${{ env.artifact_name }}

    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive

    - name: make_directory
      run: |
        cmake -E make_directory ${{env.SOURCE_DIR}}
        cmake -E make_directory ${{env.TOOLS_DIR}}
        cmake -E make_directory ${{env.INSTALL_DIR}}
        cmake -E make_directory ${{github.workspace}}/build

    - name: Cache installed
      if: false
      uses: actions/cache@v5
      id: cache-installed
      with:
        path: |
          ${{env.TOOLS_DIR}}
        key: install-doxygen

    - name: git clone RabbitCommon
      working-directory: ${{env.SOURCE_DIR}}
      run: git clone https://github.com/KangLin/RabbitCommon.git

    - name: install apt packages
      run: |
        sudo ./Script/build_depend.sh --system_update --base --default --install ${{env.INSTALL_DIR}}

    - name: Download doxygen
      run: |
        if [ ! -d ${{env.TOOLS_DIR}}/doxygen-${{env.DOXYGEN_VERSION}} ]; then
            cd ${{env.TOOLS_DIR}}
            wget https://www.doxygen.nl/files/doxygen-${{env.DOXYGEN_VERSION}}.linux.bin.tar.gz
            tar xzf doxygen-${{env.DOXYGEN_VERSION}}.linux.bin.tar.gz
        fi
        sudo cp ${{env.TOOLS_DIR}}/doxygen-${{env.DOXYGEN_VERSION}}/bin/doxygen /usr/bin/doxygen

    - name: build doxygen
      working-directory: ${{github.workspace}}
      env:
        RabbitCommon_ROOT: ${{env.SOURCE_DIR}}/RabbitCommon
        BUILD_DOCS: ON
      run: |
        cmake -E make_directory ${{github.workspace}}/build
        cd ${{github.workspace}}/build
        cmake ${{github.workspace}} \
            -DBUILD_APP=OF \
            -DBUILD_CLIENT=OFF \
            -DBUILD_PLUGINS=OFF \
            -DBUILD_SERVICE=OFF \
            -DWITH_ABOUT=OFF \
            -DWITH_ADMINAUTHORISER=OFF \
            -DWITH_UPDATE=OFF \
            -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
            -DCMAKE_INSTALL_PREFIX=${{github.workspace}}/build/install \
            -DBUILD_DOCS=ON
        cmake --build . --target doc_Chinese doc_English
        7z a RabbitRemoteControl_${{env.RabbitRemoteControl_VERSION}}_document.zip Doxygen/*

    - name: Update artifact
      uses: actions/upload-artifact@v7
      with:
        name: ${{ env.artifact_name }}
        path: |
          ${{github.workspace}}/build/RabbitRemoteControl_${{env.RabbitRemoteControl_VERSION}}_document.zip

    - name: Deploy to GitHub Pages
      if: startsWith(github.ref, 'refs/tags/')
      uses: crazy-max/ghaction-github-pages@v2
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        target_branch: gh-pages
        build_dir: build/Doxygen

    - name: Deploy to sourceforge.io
      if: startsWith(github.ref, 'refs/tags/')
      working-directory: ${{env.SOURCE_DIR}}
      run: |
        echo "${{secrets.GIT_SSH_PRIVATE_KEY}}" > id_rsa
        chmod 600 id_rsa
        scp -i id_rsa -o StrictHostKeyChecking=no -r ${{github.workspace}}/build/Doxygen/. kl222@web.sourceforge.net:/home/project-web/rabbitremotecontrol/htdocs/${{env.RabbitRemoteControl_VERSION}}