search

sharkdp / insect

High precision scientific calculator with support for physical units
https://numbat.dev/
MIT License
3.17k stars 126 forks source link

Check in CI that the README is up to date #319

Closed triallax closed 2 years ago

triallax commented 2 years ago

I made a small edit to the README to test this out.

triallax commented 2 years ago

So the CI check seems to erroneously fail even with no change in the README, and running the same lines locally outputs no error. I have no idea why this is happening.

PS: apologies for the spam due to all my force pushes.

sharkdp commented 2 years ago

Can we output the diff (by simply calling git diff README.md, I guess?) after the error message? Maybe it's due to a different pandoc version compared to your local installation?

triallax commented 2 years ago

Your hunch was correct; the CI installs Pandoc 2.5, while I have 2.18 locally. How do you suggest we solve this dilemma (different versions between CI and local installation)?

sharkdp commented 2 years ago

We could use one of the docker images and pin a specific version of pandoc (e.g. 2.18 for now, which is on https://hub.docker.com/r/pandoc/core/tags)? https://github.com/pandoc/pandoc-action-example#simple-usage

For local use, we could either ask developers to also use that docker image or to install the same version (both are not ideal, but I don't have a better solution right now).

triallax commented 2 years ago

Okay, I got it to work with the Docker image that you linked to.

triallax commented 2 years ago

@sharkdp please merge if this looks good to you.