From 4c626c2148aab4c0793c96c444b9ef59f231e48d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dietrich=20Kr=C3=B6nke?= Date: Mon, 4 Jan 2021 20:21:00 +0100 Subject: [PATCH] iox-#468 integrate doxygen in build workflow MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Dietrich Krönke --- .github/workflows/build-test.yml | 14 ++++++-- .github/workflows/doxygen.yml | 41 ------------------------ doc/aspice_swe3_4/example/COLCON_IGNORE | 0 doc/aspice_swe3_4/swe_docu_guidelines.md | 2 +- 4 files changed, 13 insertions(+), 44 deletions(-) delete mode 100644 .github/workflows/doxygen.yml create mode 100644 doc/aspice_swe3_4/example/COLCON_IGNORE diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml index 82907970c5..114febad23 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build-test.yml @@ -21,14 +21,17 @@ jobs: - name: Install iceoryx dependencies # Softwares installed in ubuntu-18.04 instance # https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md - run: sudo apt-get update && sudo apt-get install -y libacl1-dev libncurses5-dev + run: | + sudo apt-get update + sudo apt-get install -y libacl1-dev libncurses5-dev doxygen graphviz texlive-font-utils \ + plantuml texlive-latex-base texlive-latex-recommended texlive-fonts-recommended - name: Checkout uses: actions/checkout@v2 - name: Build sources run: | - $GITHUB_WORKSPACE/tools/iceoryx_build_test.sh build-strict build-all out-of-tree + $GITHUB_WORKSPACE/tools/iceoryx_build_test.sh build-strict build-all out-of-tree doc - name: Run timeless tests run: | @@ -40,6 +43,13 @@ jobs: cd $GITHUB_WORKSPACE/build make timing_tests + - name: Archive generated doxygen + uses: actions/upload-artifact@v2 + with: + name: iceoryx-pdf + path: ./build/doc/*.pdf + retention-days: 30 + # This job builds & runs iceoryx tests in macos-10.15 iceoryx-macos: runs-on: macos-latest diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml deleted file mode 100644 index a3b57d8cb7..0000000000 --- a/.github/workflows/doxygen.yml +++ /dev/null @@ -1,41 +0,0 @@ -# This workflow builds & runs test cases in iceoryx - -name: Doxygen Generation - -# Triggers the workflow on push or pull request events but only for the master branch -on: - push: - branches: [ master ] - pull_request: - branches: [ master ] - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # This job builds & runs iceoryx tests in ubuntu-18.04 - iceoryx-coverage-ubuntu: - # The type of runner that the job will run on - runs-on: ubuntu-20.04 - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - - name: Install iceoryx dependencies - # Softwares installed in ubuntu-18.04 instance - # https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md - run: | - sudo apt-get update - sudo apt-get install -y libacl1-dev libncurses5-dev git cmake build-essential doxygen graphviz texlive-base texlive-font-utils plantuml - - - name : Checkout - uses: actions/checkout@v2 - - - name: Build, test and generate doxygen - run: | - $GITHUB_WORKSPACE/tools/iceoryx_build_test.sh build-all doc - - - name: Archive code coverage results - uses: actions/upload-artifact@v2 - with: - name: iceoryx-pdf - path: | - ./build/doc/*.pdf - retention-days: 30 diff --git a/doc/aspice_swe3_4/example/COLCON_IGNORE b/doc/aspice_swe3_4/example/COLCON_IGNORE new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/aspice_swe3_4/swe_docu_guidelines.md b/doc/aspice_swe3_4/swe_docu_guidelines.md index 50046669b0..c9aa913d16 100644 --- a/doc/aspice_swe3_4/swe_docu_guidelines.md +++ b/doc/aspice_swe3_4/swe_docu_guidelines.md @@ -118,5 +118,5 @@ In iceoryx Pull-Requests are pdf files generated and uploaded to the Github arti If you want to download the pdf files from the Pull-Requests or master build you can do it by the following way: * Open the "Checks" view in the PR - * Open the "Details" link for the check `Doxygen Generation` + * Open the "Details" link for the check `iceoryx-ubuntu` in `Build & Test` * On the right side you find a menu button `Artifacts` which shows `iceoryx-pdf` as download link \ No newline at end of file