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

Request for a release #20

Closed
mbarbin opened this issue Aug 22, 2024 · 7 comments
Closed

Request for a release #20

mbarbin opened this issue Aug 22, 2024 · 7 comments
Assignees

Comments

@mbarbin
Copy link
Collaborator

mbarbin commented Aug 22, 2024

Hello,
I would like to request the submission of a release for the pp project to the opam repository. I'd like to use the couple new helpers that were added, plus it's been a little while since the last release.
Thanks!

@rgrinberg
Copy link
Contributor

Do you want to do the honours? I added you as a maintainer.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Aug 23, 2024

Yes! Thank you for appointing me as a maintainer.

Looking back at the unreleased changes, I see #17 which is a breaking change. Does it warrant a major semver increase? In theory I would say yes (a.k.a. releasing pp.2.0.0). That being said I looked via sherlocode, and didn't find a match for the Pp.of_fmt, outside of the test for this library. https://sherlocode.com/?q=Pp.of_fmt

For commits that prepare the changelog, do maintainers push directly to the main branch, or is it better to go via a PR as well?

@mbarbin mbarbin self-assigned this Aug 23, 2024
@rgrinberg
Copy link
Contributor

Looking back at the unreleased changes, I see #17 which is a breaking change. Does it warrant a major semver increase? In theory I would say yes (a.k.a. releasing pp.2.0.0). That being said I looked via sherlocode, and didn't find a match for the Pp.of_fmt, outside of the test for this library. sherlocode.com?q=Pp.of_fmt

Both are acceptable to me. Pp.of_fmt was not very useful in hindsight as it breaks the purpose of this library which is serialization.

For commits that prepare the changelog, do maintainers push directly to the main branch, or is it better to go via a PR as well?

Whatever you prefer.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Aug 26, 2024

Pp.of_fmt was not very useful in hindsight as it breaks the purpose of this library which is serialization.

So far I've used pp in a spirit that matches what the introductory paragraph says in the home page's README, and didn't think about serialization. I'm curious - does Dune use Pp to send errors to ocaml-lsp? Are there other use cases?

I'm inclined to name the release 2.0.0. The focus on serialization could be considered a minor change to the original project motivation, hereby dropping the (unused says sherlocode) Pp.of_fmt feature of "making it easier to migrate code from using Format to using Pp". That sounds fine to me.

I'm going to be on and off the next few days, so I might not get to it right away, but please consider it on my stack and I will get this release done. Thanks!

@rgrinberg
Copy link
Contributor

I'm curious - does Dune use Pp to send errors to ocaml-lsp? Are there other use cases?

Yes, it was introduced exactly for this purpose. No other use cases as far so far as I'm aware. We also introduced a combinator based API because of the general dislike for format strings.

I'm inclined to name the release 2.0.0. The focus on serialization could be considered a minor change to the original project motivation, hereby dropping the (unused says sherlocode) Pp.of_fmt feature of "making it easier to migrate code from using Format to using Pp". That sounds fine to me.

That's OK.

I'm going to be on and off the next few days, so I might not get to it right away, but please consider it on my stack and I will get this release done. Thanks!

Roger.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 10, 2024

Work in progress in #21.

@mbarbin
Copy link
Collaborator Author

mbarbin commented Sep 17, 2024

Merged ocaml/opam-repository#26570

@mbarbin mbarbin closed this as completed Sep 17, 2024
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