mirage / ocaml-github

GitHub APIv3 OCaml bindings
ISC License
100 stars 61 forks source link

remove name and version from opam file #182

Closed yomimono closed 7 years ago

yomimono commented 7 years ago

As I understand it, these fields aren't required.

dsheets commented 7 years ago

The fields are not required but they make pinning easier:

opam pin add .

used to work but now fails and one must write

opam pin add github .

instead.

The version field is somewhat less useful as it is usually lagging during development (this matches opam's default for pinned package versions of published packages). It is slightly useful in that it lets you check out any commit and pin the package to the last version published at the time of commit. It also provides an obvious place to modify when testing the package during development.

I recommend using opam-publish which removes these fields before submission to opam-repository.

I keep the version field up-to-date as part of my publication workflow. I'm unclear on what is gained by removing these fields.

@samoht why did you merge this?

samoht commented 7 years ago

Sorry, I didn't realised that you use it in your workflow, feel free to revert. I tend to remove these fields from the opam file that I see in the wild, as the version number easily gets out-of-date.