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

Release mod 1.0 #26296

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Release mod 1.0 #26296

wants to merge 1 commit into from

Conversation

vog
Copy link

@vog vog commented Jul 27, 2024

No description provided.

dev-repo: "git+https://gitlab.com/v0g/mod.git"
url {
src:
"https://gitlab.com/-/project/60374965/uploads/baf2217bcdcb1a66362ab6aa82c0fdf1/mod-1.0.tar.zst"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

opam is unable to unpack this file

@mseri
Copy link
Member

mseri commented Jul 29, 2024

It would be useful either in the library or in the opam file description (or both) to explain what does it mean that they are proper modulo operators and how to use them, especially for a 1.0 release.

@avsm
Copy link
Member

avsm commented Aug 16, 2024

@vog have you had a chance to look at the above? Happy to help with any questions you have about opam, if any, but you need to make the decisions about your own package.

@vog
Copy link
Author

vog commented Aug 16, 2024

Thanks for your feedback.

I'll add an explanation.

However, I don't understand what you mean by "opam is unable to unpack this file". I just tested it by hand on a plain Debian system, where I can download and unpack the source archive without any errors or warnings:

$ curl -O https://gitlab.com/-/project/60374965/uploads/baf2217bcdcb1a66362ab6aa82c0fdf1/mod-1.0.tar.zst
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  4095  100  4095    0     0   8408      0 --:--:-- --:--:-- --:--:--  8408

$ tar xvf mod-1.0.tar.zst 
mod-1.0/LICENSE
mod-1.0/Makefile
mod-1.0/dune
mod-1.0/dune-project
mod-1.0/src/build/release
mod-1.0/src/lib/Makefile
mod-1.0/src/lib/Mod.ml
mod-1.0/src/lib/Mod.mli
mod-1.0/src/lib/dune
mod-1.0/src/test/Makefile
mod-1.0/src/test/Test.ml
mod-1.0/src/test/Test.t
mod-1.0/src/test/dune

@shonfeder
Copy link
Collaborator

shonfeder commented Aug 21, 2024

@vog You can see the error in our CI here https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/e0e9c62df312c7a170343e5119054fa24510f25a/variant/compilers,4.14,mod.1.0

E.g.,

mod.1.0 is not installed. Install it? [y/n] y
The following actions will be performed:
=== install 2 packages
  - install dune 3.16.0       [required by mod]
  - install mod  1.0 (pinned)

<><> Processing actions <><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-> retrieved dune.3.16.0  (cached)
[ERROR] Failed to get sources of mod.1.0: Unknown archive type: /home/opam/.opam/download-cache/sha256/4f/4fef6f1e2c56813ad4da5131e90f3f31bf670a3d90e598fdb9be64f735638772
-> installed dune.3.16.0

#=== ERROR while fetching sources for mod.1.0 =================================#
OpamSolution.Fetch_fail("Could not extract archive:\nUnknown archive type: /home/opam/.opam/download-cache/sha256/4f/4fef6f1e2c56813ad4da5131e90f3f31bf670a3d90e598fdb9be64f735638772")

opam doesn't support the zst compression format currently. Thanks to this PR, we have planned work now to specify this in the manual (see ocaml/opam#6171), but you can currently see the supported formats here: https://github.com/shonfeder/opam/blob/main/src/core/opamSystem.ml#L830-L853

@yawaramin
Copy link
Contributor

Hello, taking a look at the interface file here: https://gitlab.com/v0g/mod/-/blob/main/src/lib/Mod.mli?ref_type=heads

It seems like there are no docstrings (nor readme file), would you mind adding some docstrings that people could refer to? The reason I mention this is because publishing on the opam-repository will trigger the documentation to be built and served in the OCaml website. So it would be helpful if there was some documentation in the module.

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

Successfully merging this pull request may close these issues.

5 participants