-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Copyright VMware, Inc. | ||
# SPDX-License-Identifier: APACHE-2.0 | ||
|
||
name: '[CI/CD] Markdown linter' | ||
on: | ||
push: | ||
branches: [ "master" ] | ||
paths: | ||
- '**.md' | ||
|
||
pull_request: | ||
branches: [ 'master' ] | ||
paths: | ||
- '**.md' | ||
# Remove all permissions by default | ||
permissions: {} | ||
jobs: | ||
markdown-linter: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: read | ||
steps: | ||
- name: Install mardownlint | ||
run: npm install -g [email protected] | ||
- name: Checkout project | ||
uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 | ||
- name: Execute markdownlint | ||
env: | ||
DIFF_URL: "${{github.event.pull_request.diff_url}}" | ||
TEMP_FILE: "${{runner.temp}}/pr-${{github.event.number}}.diff" | ||
TEMP_OUTPUT: "${{runner.temp}}/output" | ||
run: | | ||
# This request doesn't consume API calls. | ||
curl -Lkso $TEMP_FILE $DIFF_URL | ||
files_changed="$(sed -nr 's/[\-\+]{3} [ab]\/(.*)/\1/p' $TEMP_FILE | sort | uniq)" | ||
md_files="$(echo "$files_changed" | grep -o ".*\.md$" | sort | uniq || true)" | ||
# Create an empty file, useful when the PR changes ignored files | ||
touch "${TEMP_OUTPUT}" | ||
exit_code=0 | ||
for f in ${md_files}; do | ||
# Looking for links that do not start with https, # or img | ||
if grep --quiet --perl-regexp '\]\((?!(http|#|img))[^\)]*' $f; then | ||
echo "::error:: Please ensure all links in $f starts with http(s), # or img" | ||
exit 1 | ||
fi | ||
done | ||
markdownlint -o "${TEMP_OUTPUT}" ${md_files[@]} || exit_code=$? | ||
while read -r line; do | ||
# line format: | ||
# file:row[:column] message | ||
# white space inside brackets is intentional to detect the message for the notice. | ||
message="${line#*[ ]}" | ||
file_row_column="${line%%[ ]*}" | ||
# Split by ':' | ||
readarray -d : -t strarr < <(printf '%s' "$file_row_column") | ||
if [[ "${#strarr[@]}" -eq 3 ]]; then | ||
echo "::warning file=${strarr[0]},line=${strarr[1]},col=${strarr[2]}::${message}" | ||
elif [[ "${#strarr[@]}" -eq 2 ]]; then | ||
echo "::warning file=${strarr[0]},line=${strarr[1]}::${message}" | ||
else | ||
echo "::warning:: Error processing: ${line}" | ||
fi | ||
done < "${TEMP_OUTPUT}" | ||
if [[ $exit_code -ne 0 ]]; then | ||
echo "::error:: Please review linter messages" | ||
exit "$exit_code" | ||
fi |