Skip to content

Commit 329ce71

Browse files
committed
iox-eclipse-iceoryx#1294 Print warning for unsupported code environment starting with 4 `, NOLINT comment directly after links
Signed-off-by: Christian Eltzschig <me@elchris.org>
1 parent 818b6c4 commit 329ce71

File tree

3 files changed

+17
-3
lines changed

3 files changed

+17
-3
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -289,11 +289,11 @@ Or with a comment one line above (the number after the warning number indicates
289289
*mynullptr = foo;
290290
```
291291

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

295295
Don't be afraid if you don't have Axivion available. As we want to make it easy for developers to contribute,
296-
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-->
296+
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-->.
297297

298298
### Header
299299

QUALITY_DECLARATION.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,4 +194,4 @@ Every release that is integrated with ROS will be build with the ROS CI to ensur
194194
This package conforms to the Vulnerability Disclosure Policy in REP-2006.
195195
The Eclipse Project Handbook states the project's [vulnerability disclosure policy](https://www.eclipse.org/projects/handbook/#vulnerability-disclosure) in detail.
196196

197-
The [iceoryx website](https://iceoryx.io) provides a link to report a security vulnerability. <!--NOLINT explicit link to website-->
197+
The [iceoryx website](https://iceoryx.io)<!--NOLINT explicit link to website--> provides a link to report a security vulnerability.

tools/ci/markdown-link-verificator.sh

+14
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,20 @@ checkLinksInFile()
234234
do
235235
let LINE_NR=$LINE_NR+1
236236

237+
# it is possible to have code environments like
238+
# ````
239+
# ```
240+
# hello world
241+
# ```
242+
# ````
243+
# this is at the moment not supported, only ``` so we print a warning when we
244+
# encounter such a line
245+
if [[ $(echo $LINE | grep -E "^[ ]*\`\`\`\`" | wc -l) == "1" ]]
246+
then
247+
echo -e ${COLOR_LIGHT_RED}File: $FILE, markdown code environment with more than 3 \` are not supported. You may encounter false positives.${COLOR_RESET}
248+
continue
249+
fi
250+
237251
# detect code environments, see ``` and skip them
238252
if [[ $(echo $LINE | grep -E "^[ ]*\`\`\`" | wc -l) == "1" ]]
239253
then

0 commit comments

Comments
 (0)