modified: .github/workflows/md-check.yml
This commit is contained in:
1 parent
185f387b34
commit
d8ce6f5129
1 file changed
+31
-24
@@ -26,57 +26,64 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
BEFORE="${{ github.event.before }}"
|
# 收集根目录下所有 .cpp / .md 文件(不含子目录)
|
||||||
AFTER="${{ github.event.after }}"
|
mapfile -t CPP_FILES < <(find . -maxdepth 1 -name '*.cpp' -type f | sed 's|^\./||' | sort)
|
||||||
|
mapfile -t MD_FILES < <(find . -maxdepth 1 -name '*.md' -type f | sed 's|^\./||' | sort)
|
||||||
|
|
||||||
# 处理新分支第一次 push 的情况(before 为全零)
|
CPP_COUNT=${#CPP_FILES[@]}
|
||||||
if [ "$BEFORE" = "0000000000000000000000000000000000000000" ]; then
|
MD_COUNT=${#MD_FILES[@]}
|
||||||
CHANGED_FILES=$(git diff --name-only --diff-filter=ACM 4b825dc642cb6eb9a060e54bf8d69288fbee4904 "$AFTER" || true)
|
|
||||||
else
|
echo "根目录下 .cpp 文件数: ${CPP_COUNT}"
|
||||||
CHANGED_FILES=$(git diff --name-only --diff-filter=ACM "$BEFORE" "$AFTER" || true)
|
echo "根目录下 .md 文件数: ${MD_COUNT}"
|
||||||
|
|
||||||
|
# 情况 1:仅有 cpp 无 md —— 输出日志后跳过
|
||||||
|
if [ "$CPP_COUNT" -gt 0 ] && [ "$MD_COUNT" -eq 0 ]; then
|
||||||
|
echo "本次 push 根目录下仅有 .cpp 文件而无 .md 文件,跳过 md 首行配对检查。"
|
||||||
|
echo "has_cpp=true" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# 筛选出根目录下的 .cpp / .md 文件
|
# 情况 2:仅有 md 无 cpp —— 报错
|
||||||
CPP_FILES=$(echo "$CHANGED_FILES" | grep -E '^[^/]+\.cpp$' || true)
|
if [ "$MD_COUNT" -gt 0 ] && [ "$CPP_COUNT" -eq 0 ]; then
|
||||||
MD_FILES=$(echo "$CHANGED_FILES" | grep -E '^[^/]+\.md$' || true)
|
echo "::error::根目录下仅有 .md 文件而无 .cpp 文件,请补充对应的 .cpp 文件"
|
||||||
|
echo "has_cpp=false" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
if [ -z "$CPP_FILES" ]; then
|
# 情况 3:两者都不存在 —— 跳过
|
||||||
echo "本次 push 没有根目录下的 .cpp 文件变更,跳过检查。"
|
if [ "$CPP_COUNT" -eq 0 ] && [ "$MD_COUNT" -eq 0 ]; then
|
||||||
|
echo "根目录下没有 .cpp/.md 文件,跳过检查。"
|
||||||
echo "has_cpp=false" >> "$GITHUB_OUTPUT"
|
echo "has_cpp=false" >> "$GITHUB_OUTPUT"
|
||||||
exit 0
|
exit 0
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "has_cpp=true" >> "$GITHUB_OUTPUT"
|
echo "has_cpp=true" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
# 若提交中没有任何 .md 变更,则跳过标题配对检查,直接放行
|
|
||||||
if [ -z "$MD_FILES" ]; then
|
|
||||||
echo "本次 push 没有根目录下的 .md 文件变更,跳过标题配对检查。"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
EXIT_CODE=0
|
EXIT_CODE=0
|
||||||
|
|
||||||
while IFS= read -r cpp_file; do
|
# 3a:每个 .cpp 必须有同名 .md
|
||||||
[ -z "$cpp_file" ] && continue
|
for cpp_file in "${CPP_FILES[@]}"; do
|
||||||
base=$(basename "$cpp_file" .cpp)
|
base=$(basename "$cpp_file" .cpp)
|
||||||
md_file="${base}.md"
|
md_file="${base}.md"
|
||||||
|
|
||||||
if [ ! -f "$md_file" ]; then
|
if [ ! -f "$md_file" ]; then
|
||||||
echo "::error file=${cpp_file}::对应的 Markdown 文件 ${md_file} 不存在"
|
echo "::error file=${cpp_file}::对应的 Markdown 文件 ${md_file} 不存在"
|
||||||
EXIT_CODE=1
|
EXIT_CODE=1
|
||||||
continue
|
|
||||||
fi
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# 3b:每个 .md 的第一行必须匹配 "# <base> ..."
|
||||||
|
for md_file in "${MD_FILES[@]}"; do
|
||||||
|
base=$(basename "$md_file" .md)
|
||||||
FIRST_LINE=$(head -n 1 "$md_file")
|
FIRST_LINE=$(head -n 1 "$md_file")
|
||||||
|
|
||||||
# 检查第一行是否匹配 "# <base> 任意内容"
|
if [[ "$FIRST_LINE" != "# ${base} "* ]]; then
|
||||||
if ! grep -qE "^# ${base} .*$" <<< "$FIRST_LINE"; then
|
|
||||||
echo "::error file=${md_file},line=1::Markdown 第一行格式错误。期望以 '# ${base} ' 开头,实际为: ${FIRST_LINE}"
|
echo "::error file=${md_file},line=1::Markdown 第一行格式错误。期望以 '# ${base} ' 开头,实际为: ${FIRST_LINE}"
|
||||||
EXIT_CODE=1
|
EXIT_CODE=1
|
||||||
else
|
else
|
||||||
echo "✅ ${md_file} 第一行格式正确: ${FIRST_LINE}"
|
echo "✅ ${md_file} 第一行格式正确: ${FIRST_LINE}"
|
||||||
fi
|
fi
|
||||||
done <<< "$CPP_FILES"
|
done
|
||||||
|
|
||||||
exit $EXIT_CODE
|
exit $EXIT_CODE
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user