Skip to content

Commit e0d1293

Browse files
authored
ci: add instructions that explain how to fix spellcheck errors (#7016)
1 parent 480c010 commit e0d1293

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

.github/workflows/ci.yml

+18-2
Original file line numberDiff line numberDiff line change
@@ -1102,6 +1102,22 @@ jobs:
11021102
false
11031103
}
11041104
- name: Run cargo-spellcheck
1105-
run: cargo spellcheck --code 1
1105+
run: |
1106+
if ! cargo spellcheck --code 1
1107+
then
1108+
echo ''
1109+
echo ''
1110+
echo 'If this is a Rust method/type/variable name, then you should'
1111+
echo 'enclose it in backticks like this: `MyRustType`.'
1112+
echo ''
1113+
echo 'If this is a real word, then you can add it to spellcheck.dic'
1114+
exit 1
1115+
fi
11061116
- name: Detect trailing whitespace
1107-
run: if grep --exclude-dir=.git --exclude-dir=target -re '\s$' . ; then exit 1; fi
1117+
run: |
1118+
if grep --exclude-dir=.git --exclude-dir=target -rne '\s$' .
1119+
then
1120+
echo ''
1121+
echo 'Please remove trailing whitespace from these lines.'
1122+
exit 1
1123+
fi

0 commit comments

Comments
 (0)