added markdownlint checks #15
Conversation
docker-compose.yml
Outdated
| image: gouvinb/docker-markdownlint | ||
| command: --version | ||
| volumes: | ||
| - .:/data |
There was a problem hiding this comment.
I know this will raise red flags. It's not for runtime and we could also run it without docker-compose if that was preferable.
There was a problem hiding this comment.
This can work (with care about .pyc, .pyo, permissions etc.) but it needs to be into docker-compose.override.yml so that CI doesn't use it
There was a problem hiding this comment.
I meant, the volume, but maybe it's not usable without the volume at all?
There was a problem hiding this comment.
It's not a resident service nor an image to be built, so could use docker run --rm -v ... directly
There was a problem hiding this comment.
Well, in this case ci is meant to use it as well to check the markdown. Here we only care about the markdown files really. And we could mark it as read only.
There was a problem hiding this comment.
Yes, might be better to run it without compose. The only advantage would be to expose all of the images that are used at any stage of the project.
There was a problem hiding this comment.
We could also create an image where we copy the markdown files in but that seems overkill.
There was a problem hiding this comment.
I'd go for a single docker run command, as it is an image used in the development phase but not involved in running the application
There was a problem hiding this comment.
okay, that's done now. Also adjusted the README to match the rules.
|
|
||
| set -e | ||
|
|
||
| docker run --rm -v $(pwd):/data gouvinb/docker-markdownlint \ |
There was a problem hiding this comment.
the size of the image seems acceptable, and the risk low (only has a latest tag)
Part of: libero/publisher#35
The docker image used was last pushed a year ago. Maybe we want to maintain our own image. Assuming this approach of running it via docker is acceptable. Although it seems to work adequately.
DavidAnson/markdownlint might be preferrable as it seems actively developed (and has a plugin for VSCode)