Files
containers/.github/workflows/markdown-linter.yml
dependabot[bot] 34ba947c43 Bump actions/checkout from 6.0.0 to 6.0.1 (#88888)
Bumps [actions/checkout](https://github.com/actions/checkout) from 6.0.0 to 6.0.1.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](1af3b93b68...8e8c483db8)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-12-08 08:46:48 +01:00

56 lines
2.1 KiB
YAML

# Copyright Broadcom, Inc. All Rights Reserved.
# SPDX-License-Identifier: APACHE-2.0
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@8e8c483db84b4bee98b60c0593521ed34d9990e8
- 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
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