third_party/ot-br-posix/repo/.github/workflows/documentation.yml

   1 #
   2 ##  Copyright (c) 2021, The OpenThread Authors.
   3 ##  All rights reserved.
   4 ##
   5 ##  Redistribution and use in source and binary forms, with or without
   6 ##  modification, are permitted provided that the following conditions are met:
   7 ##  1. Redistributions of source code must retain the above copyright
   8 ##     notice, this list of conditions and the following disclaimer.
   9 ##  2. Redistributions in binary form must reproduce the above copyright
  10 ##     notice, this list of conditions and the following disclaimer in the
  11 ##     documentation and/or other materials provided with the distribution.
  12 ##  3. Neither the name of the copyright holder nor the
  13 ##     names of its contributors may be used to endorse or promote products
  14 ##     derived from this software without specific prior written permission.
  15 ##
  16 ##  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 ##  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 ##  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ##  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20 ##  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 ##  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 ##  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 ##  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 ##  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 ##  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 ##  POSSIBILITY OF SUCH DAMAGE.
  27 ##
  28
  29 name: Documentation
  30
  31 on:
  32   push:
  33     branches:
  34     - master
  35
  36 jobs:
  37   cancel-previous-runs:
  38     runs-on: ubuntu-latest
  39     steps:
  40     - uses: rokroskar/workflow-run-cleanup-action@master
  41       env:
  42         GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
  43       if: "github.ref != 'refs/heads/master'"
  44
  45   doxygen:
  46     runs-on: ubuntu-latest
  47     steps:
  48     - uses: actions/checkout@v2
  49       with:
  50         submodules: true
  51     - name: Bootstrap
  52       run: |
  53         sudo apt-get update
  54         sudo apt-get install -y doxygen libdbus-1-dev libglib2.0-dev-bin xmlto
  55     - name: Generate
  56       run: |
  57         mkdir build-doc
  58         cd build-doc
  59         cmake -DBUILD_TESTING=OFF -DOTBR_DOC=ON -DOTBR_DBUS=ON ..
  60         make otbr-doc
  61     - name: Deploy
  62       uses: peaceiris/actions-gh-pages@v3
  63       with:
  64         github_token: ${{ secrets.GITHUB_TOKEN }}
  65         publish_dir: ./build-doc/doc/html