Skip to content

Commit b2a94fa

Browse files
committed
Added rosdoc_lite check
1 parent a6bd89e commit b2a94fa

File tree

5 files changed

+51
-0
lines changed

5 files changed

+51
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
FROM ros:noetic
2+
COPY entrypoint.sh /entrypoint.sh
3+
4+
RUN apt-get update && apt-get install -y \
5+
ros-noetic-rosdoc-lite \
6+
graphviz
7+
8+
ENTRYPOINT ["/entrypoint.sh"]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# action.yml
2+
name: 'check rosdoc_lite'
3+
description: 'runs rosdoc_lite and check for warnings and errors'
4+
runs:
5+
using: 'docker'
6+
image: 'Dockerfile'
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#!/bin/bash
2+
3+
source /opt/ros/noetic/setup.bash
4+
5+
IGNORE_PATTERN_FILE=.rosdoc_ignore_patterns
6+
7+
OUT_DIR=$(mktemp -d)
8+
9+
# We are only interested in stderr, hence we forward stdout to /dev/null
10+
# As we want to parse the output using sed, we need to pipe stderr to stdout afterwards to we can process it
11+
err_output=$(rosdoc_lite . -o ${OUT_DIR} 2>&1 > /dev/null | grep -v -E -f $IGNORE_PATTERN_FILE)
12+
13+
if [[ -z "$err_output" ]]; then
14+
echo "Check successful. rosdoc_lite didn't report any errors or warnings."
15+
else
16+
echo $err_output
17+
echo "rosdoc_lite found errors or warnings."
18+
exit 1
19+
fi
20+
exit 0

.github/workflows/ci.yml

+6
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,9 @@ jobs:
5656
--exclude=tcp_socket.cpp \
5757
--exclude=real_time.md
5858
59+
rosdoc_lite_check:
60+
runs-on: ubuntu-latest
61+
steps:
62+
- uses: actions/checkout@v1
63+
- uses: ./.github/actions/rosdoc_lite_action
64+

.rosdoc_ignore_patterns

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
2+
warning: Tag 'TCL_SUBST' at line [0-9]+ of file '[a-zA-Z0-9_/]+' has become obsolete.
3+
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 986 of file '[a-zA-Z0-9_/]+' has become obsolete.
4+
warning: Tag 'PERL_PATH' at line [0-9]+ of file '[a-zA-Z0-9_/]+' has become obsolete.
5+
warning: Tag 'MSCGEN_PATH' at line [0-9]+ of file '[a-zA-Z0-9_/]+' has become obsolete.
6+
warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value
7+
Using the default: a4!
8+
warning: tag INCLUDE_PATH: include path '\$INCLUDE_PATH' does not exist
9+
warning: source '\$INCLUDE_PATH' is not a readable file or directory... skipping.
10+
warning: source \$INCLUDE_PATH is not a readable file or directory... skipping.
11+
^$

0 commit comments

Comments
 (0)