Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into iox-eclipse-iceoryx…
Browse files Browse the repository at this point in the history
…#136-mkdocs-export-for-website
  • Loading branch information
mossmaurice committed Jan 8, 2021
2 parents 02c4480 + 64fa389 commit 5e5d309
Show file tree
Hide file tree
Showing 33 changed files with 542 additions and 7,533 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/build-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ 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
sudo apt-get install -y plantuml texlive-latex-base texlive-latex-extra texlive-latex-recommended texlive-fonts-recommended
- name: Checkout
uses: actions/checkout@v2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This workflow builds & runs test cases in iceoryx

name: Build, Test and get Test-Coverage
name: Test Coverage + Doxygen Documentation

# Triggers the workflow on push or pull request events but only for the master branch
on:
Expand All @@ -12,16 +12,19 @@ on:
# 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:
iceoryx-coverage-doxygen-ubuntu:
# The type of runner that the job will run on
runs-on: ubuntu-18.04
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 lcov
run: |
sudo apt-get update
sudo apt-get install -y libacl1-dev libncurses5-dev git cmake build-essential doxygen graphviz texlive-font-utils lcov
sudo apt-get install -y plantuml texlive-latex-base texlive-latex-extra texlive-latex-recommended texlive-fonts-recommended
- name : Checkout
uses: actions/checkout@v2
Expand All @@ -30,6 +33,7 @@ jobs:
run: |
# add flag to include coverage
$GITHUB_WORKSPACE/tools/iceoryx_build_test.sh build-strict debug build-all out-of-tree -c unit
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v1
with:
Expand All @@ -45,3 +49,16 @@ jobs:
!./build/lcov/*.info
retention-days: 90

- name: Generate doxygen documentation
run: |
# add flag to include coverage
$GITHUB_WORKSPACE/tools/iceoryx_build_test.sh clean doc
- name: Archive generated doxygen
uses: actions/upload-artifact@v2
with:
name: iceoryx-pdf
path: |
./build/doc/*.pdf
retention-days: 30

2 changes: 1 addition & 1 deletion .github/workflows/sanitize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
- name: Run tests
run: |
cd $GITHUB_WORKSPACE/build
../tools/run_all_tests.sh asan-only
../tools/run_all_tests.sh
# This job builds & runs iceoryx tests (with sanitizer) in macos-10.15
clang-sanitize-macos:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ All reports are stored locally in build/lcov as html report (index.html). In Git
Codecov gives a brief overview over the code coverage and also indicates in Pull-Requests if new added code is not covered by tests.
If you want to download the detailed html reports from the Pull-Requests or master build you can do it by the following way:
1. Open the "Checks" view in the PR
2. Open the "Details" link for the check `Build, Test and get Test-Coverage`
2. Open the "Details" link for the check `iceoryx-coverage-doxygen-ubuntu` in `Test Coverage + Doxygen Documentation`
3. On the right side you find a menu button `Artifacts` which shows `lcov-report` as download link

## Legal & Compliance
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![Gitter](https://badges.gitter.im/eclipse-iceoryx/iceoryx.svg)](https://gitter.im/eclipse/iceoryx)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Codecov](https://codecov.io/gh/eclipse-iceoryx/iceoryx/branch/master/graph/badge.svg?branch=master)](https://codecov.io/gh/eclipse-iceoryx/iceoryx?branch=master)

[![Sanitize](https://github.com/eclipse/iceoryx/workflows/Sanitize/badge.svg?branch=master)](https://github.com/eclipse/iceoryx/actions?query=workflow%3ASanitize)

## Introduction

Expand Down
82 changes: 82 additions & 0 deletions doc/aspice_swe3_4/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Copyright (c) 2021 Apex.AI Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

cmake_minimum_required(VERSION 3.10)

file(STRINGS "../../VERSION" iceoryx_doc_VERSION)
project(iceoryx_doc VERSION ${iceoryx_doc_VERSION})

find_package(Doxygen REQUIRED)

set(DOXYGEN_GENERATE_HTML YES)
set(DOXYGEN_GENERATE_LATEX YES)
set(DOXYGEN_GENERATE_XML YES)
set(DOXYGEN_XML_OUTPUT xml)

if(EXISTS "/usr/share/plantuml/plantuml.jar")
set(DOXYGEN_PLANTUML_JAR_PATH /usr/share/plantuml/plantuml.jar)
else()
if(DEFINED $ENV{PLANTUML_JAR_PATH})
set(DOXYGEN_PLANTUML_JAR_PATH
"$ENV{PLANTUML_JAR_PATH}"
CACHE STRING "PLANTUML location.")
else()
message(
WARNING
"plantuml.jar not found at '/usr/share/plantuml/', please set environment variable PLANTUML_JAR_PATH to the correct location."
)
endif()
endif()

set(DOXYGEN_ALIASES
[["concurrent=\xrefitem concurrent \"Concurrent\" \"Concurrency\" " \
"req=\xrefitem req \"Requirement\" \"Requirements\" " \
"link=\xrefitem link \"Link\" \"Links\" " \
swcomponent="@par Software Component:" \
error="@par Error Handling:" \
generatedcode="@par Generated by:"]])

set(COMPONENTS iceoryx_utils iceoryx_posh iceoryx_binding_c iceoryx_dds
iceoryx_introspection iceoryx_component)
set(COMPONENT_DIRS
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_utils
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_posh
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_binding_c
${CMAKE_CURRENT_SOURCE_DIR}/../../iceoryx_dds
${CMAKE_CURRENT_SOURCE_DIR}/../../tools/introspection
${CMAKE_CURRENT_SOURCE_DIR}/example/iceoryx_component)


list(LENGTH COMPONENTS tmp_len)
math(EXPR cmp_len "${tmp_len} - 1")

foreach(val RANGE ${cmp_len})
list(GET COMPONENTS ${val} cmp)
list(GET COMPONENT_DIRS ${val} cmp_dir)
message(STATUS "${cmp} ${cmp_dir}")

set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/doc/${cmp})

doxygen_add_docs(doxygen_${cmp} ${cmp_dir}/include
${cmp_dir}/source ${cmp_dir}/test ALL)
endforeach()

# create dummy install directive to generate docu also with "make install"
install(
FILES
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.doxygen_iceoryx_utils
DESTINATION
${CMAKE_CURRENT_BINARY_DIR}
)
Empty file added doc/aspice_swe3_4/COLCON_IGNORE
Empty file.
Loading

0 comments on commit 5e5d309

Please sign in to comment.