Skip to content

Commit

Permalink
iox-eclipse-iceoryx#1294 Print warning for unsupported code environme…
Browse files Browse the repository at this point in the history
…nt starting with 4 `, NOLINT comment directly after links

Signed-off-by: Christian Eltzschig <[email protected]>
  • Loading branch information
elfenpiff committed Mar 18, 2022
1 parent 818b6c4 commit 329ce71
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,11 @@ Or with a comment one line above (the number after the warning number indicates
*mynullptr = foo;
```

Scan results of the `master` branch are available on a [Axivion dashboard](https://iceoryx-axivion.apex.ai/). Please <!--NOLINT see issue: #1298-->
Scan results of the `master` branch are available on a [Axivion dashboard](https://iceoryx-axivion.apex.ai/)<!--NOLINT see issue: #1298-->. Please
contact one of the maintainers, if you're interested in getting access.

Don't be afraid if you don't have Axivion available. As we want to make it easy for developers to contribute,
please raise a pull request and one of the maintainers will provided you access to the [dashboard](https://iceoryx-axivion.apex.ai/). <!--NOLINT see issue: #1298-->
please raise a pull request and one of the maintainers will provided you access to the [dashboard](https://iceoryx-axivion.apex.ai/)<!--NOLINT see issue: #1298-->.

### Header

Expand Down
2 changes: 1 addition & 1 deletion QUALITY_DECLARATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ Every release that is integrated with ROS will be build with the ROS CI to ensur
This package conforms to the Vulnerability Disclosure Policy in REP-2006.
The Eclipse Project Handbook states the project's [vulnerability disclosure policy](https://www.eclipse.org/projects/handbook/#vulnerability-disclosure) in detail.

The [iceoryx website](https://iceoryx.io) provides a link to report a security vulnerability. <!--NOLINT explicit link to website-->
The [iceoryx website](https://iceoryx.io)<!--NOLINT explicit link to website--> provides a link to report a security vulnerability.
14 changes: 14 additions & 0 deletions tools/ci/markdown-link-verificator.sh
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,20 @@ checkLinksInFile()
do
let LINE_NR=$LINE_NR+1

# it is possible to have code environments like
# ````
# ```
# hello world
# ```
# ````
# this is at the moment not supported, only ``` so we print a warning when we
# encounter such a line
if [[ $(echo $LINE | grep -E "^[ ]*\`\`\`\`" | wc -l) == "1" ]]
then
echo -e ${COLOR_LIGHT_RED}File: $FILE, markdown code environment with more than 3 \` are not supported. You may encounter false positives.${COLOR_RESET}
continue
fi

# detect code environments, see ``` and skip them
if [[ $(echo $LINE | grep -E "^[ ]*\`\`\`" | wc -l) == "1" ]]
then
Expand Down

0 comments on commit 329ce71

Please sign in to comment.