leanprover-community / lean4-metaprogramming-book

https://leanprover-community.github.io/lean4-metaprogramming-book/
Apache License 2.0
213 stars 53 forks source link

Add CI for detecting changes to Markdown but not Lean files #113

Closed Julian closed 8 months ago

Julian commented 1 year ago

Right now the README tells contributors:

The markdown files are generated automatically via lean2md. Thus, if you're going to write or fix content for the book, please do so in the original Lean files inside the lean directory.

I.e. "change the Lean files then compile, not the markdown files".

This can lead to forgetfulness, see e.g. #111 or #112 or earlier examples.

We likely should at very least add CI which fails a PR if markdown files are changed but not Lean files.