Files
containers/.github/workflows/markdown-linter.yml
Fran Mulero bd9843ac29 [bitnami/containers] Revisit workflow permissions (#36685)
* [bitnami/containers] Revisit workflow permissions

Signed-off-by: Fran Mulero <fmulero@vmware.com>

* Apply suggestions

Signed-off-by: Fran Mulero <fmulero@vmware.com>

---------

Signed-off-by: Fran Mulero <fmulero@vmware.com>
2023-06-07 12:49:47 +02:00

52 lines
2.0 KiB
YAML

name: '[CI/CD] Markdown linter'
on:
pull_request:
branches:
- main
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 markdownlint-cli@0.33.0
- name: Checkout project
uses: actions/checkout@v3
- name: Execute markdownlint
env:
DIFF_URL: "${{github.event.pull_request.diff_url}}"
TEMP_FILE: "${{runner.temp}}/pr-${{github.event.number}}.diff"
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 ${{runner.temp}}/output
exit_code=0
markdownlint -o ${{runner.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 < ${{runner.temp}}/output
if [[ $exit_code -ne 0 ]]; then
echo "::error:: Please review linter messages"
exit "$exit_code"
fi