dune-release icon indicating copy to clipboard operation
dune-release copied to clipboard

dune-release demands a `description` field even when a `synopsis` one is present

Open c-cube opened this issue 5 years ago • 2 comments

on https://github.com/c-cube/qcheck/commit/6a170e34269164d45aba6303dff1c77cfb8b8fd0 I get errors when running dune-release lint because it seems to simply ignore the synopsis field. opam lint is all green so why is dune-release more strict?

c-cube avatar Jul 30 '20 13:07 c-cube

I think it's historically been that way and some people like that it is that strict. I understand this can be annoying so you should know that in the meantime you can pass --skip-lint to prevent the actual release process to fail because of this.

I'm not personally a huge fan of the description field and tend to always check out the project's README if I need a more in depth overview so I could consider making this a warning instead of a hard fail. Another solution would be to allow disabling the description check on a per-project basis but I'm not sure I like this one very much.

NathanReb avatar Jul 30 '20 13:07 NathanReb

could dune-release use synopsis when it's present, instead? like opam does?

c-cube avatar Jul 30 '20 14:07 c-cube