Open sverhoeven opened 4 years ago
There is a cli to run analysis locally.
There are difference between the issues raised on the website and a local analysis.
I tried to add https://github.com/codacy/codacy-remark-lint/blob/master/.remarkrc.js to the repo which helped a bit.
It's weird, because the online check sometimes passes even though there are unresolved errors.
Started in #55 to see if bundled make lesson-check-all
can be used as check in a GH Action instead of Codacy. It outputs
Episode ./_episodes/conclusions.md has badly-formatted filename
Missing or non-consecutive episode numbers [1, 2, 3, 4, 5, 6, 7, 10]
./CONTRIBUTING.md: Line(s) too long: 3, 7, 12, 13, 30, 43, 44, 48, 49, 57, 61, 64, 77
./README.md: Internally-defined links may be missing definitions: "issues"=>"FIXME"
./README.md: Line(s) too long: 3, 5, 9, 12, 13, 14, 18, 20
./_config.yml: configuration carpentry value ea is not in ('swc', 'dc', 'lc', 'cp')
./_episodes/01-introduction.md: Line(s) too long: 26, 45, 47, 49, 51, 53, 55, 57, 59, 63, 67, 73, 78, 80, 82, 83, 90, 94, 98, 104, 108, 114
./_episodes/02-installation.md: Line(s) too long: 28, 32, 64, 97, 99, 116, 172, 181, 182, 183, 196, 212
./_episodes/03-configuration.md: Line(s) too long: 26, 109, 130
./_episodes/03-configuration.md:80: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:98: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:119: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:140: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:164: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:192: Unknown or missing code block type language-YAML
./_episodes/03-configuration.md:202: Unknown or missing code block type language-YAML
./_episodes/05-preprocessor.md: Line(s) too long: 22, 26, 30, 39, 41, 45, 51, 53, 55, 58, 62, 81, 123, 225, 277, 338, 342, 344, 346
./_episodes/05-preprocessor.md:32: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:47: Unknown or missing code block type None
./_episodes/05-preprocessor.md:66: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:84: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:127: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:172: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:228: Unknown or missing code block type language-yaml
./_episodes/05-preprocessor.md:280: Unknown or missing code block type language-yaml
./_episodes/06-debugging.md: Line(s) too long: 17, 63, 91, 103, 149, 174, 210, 211, 219, 247, 280, 281, 286
./_episodes/06-debugging.md:126: Unknown or missing code block type language-YAML
./_episodes/06-debugging.md:178: Unknown or missing code block type language-YAML
./_episodes/06-debugging.md:192: Unknown or missing code block type language-YAML
./_episodes/06-debugging.md:256: Unknown or missing code block type language-YAML
./_episodes/06-debugging.md:269: Unknown or missing code block type language-YAML
./_episodes/06-debugging.md:290: Unknown or missing code block type language-YAML
./_episodes/10-development-setup.md: Line(s) too long: 16, 20, 21, 52, 58, 82, 93, 116, 117
./_episodes/conclusions.md: Line(s) too long: 20, 32, 97
Software carpentry check produces too few errors and Codacy too many.
We could also switch to markdownlint with npx -p markdownlint-cli markdownlint '**/*.md'
as a alternative check. The markdownlint is easier to run locally, you just need NodeJS.
I suppose we could do multiple checks with github actions?
As a contributor the Codacy warnings are hard to resolve. I need to wait for Codacy analysis to finish to see if I fixed the warnings and sometimes I flipflop between issues. It would be useful to me if there where instructions in the CONTRIBUTING guide how to run the Codacy analysis locally.
This problem was raised by @nielsdrost