Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce opam standards at the command level #101

Open
Risto-Stevcev opened this issue Mar 26, 2020 · 2 comments
Open

Enforce opam standards at the command level #101

Risto-Stevcev opened this issue Mar 26, 2020 · 2 comments

Comments

@Risto-Stevcev
Copy link

Right now opam publish creates a PR, which then gets reviewed by someone who them might reject it based on some mismatch in the standards required to be accepted into opam.

The suggestion here is that opam publish should reject these before the PR is even created, because it takes a while for the builds to finish and there could be quite an unnecessary delay getting new updates out with all of the back-and-forth (ie: bug fixes).

Specifically these have come up for me and would result in a rejected package during the PR review:

  • Having a version field in the .opam file.
  • Having the version constraints being too "tight" (ie: "core" {= "v0.12.0" & with-test}), I believe they all need to be >=.
  • Having test dependencies like utop, merlin, or ocamlformat. These get added as a convenience -- if someone's writing something that extends these then they would be actual dependencies.

I'm not sure if there are any other standards but I've ran into these ones so far. My suggestion is that opam publish should reject this outright and mention why without having it creating a PR and waiting for it to pass all the CI checks only for it to then have it be rejected at review.

@rjbou
Copy link
Contributor

rjbou commented Mar 30, 2020

Yes! Ideally, opam-publish should prepare the most guideline compliant. We can most of theses checks in opam-publish itself.
Ping @kit-ty-kate for proper guidelines.

@rjbou
Copy link
Contributor

rjbou commented Nov 8, 2022

Input for an opam-repo linting plugin/library

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants