-
Notifications
You must be signed in to change notification settings - Fork 701
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
PVP breakage in Cabal releases #10160
Comments
Can we use the tool GHC devs use to export the public interface of a module (library?) and have golden tests in CI? |
I'm thinking of this: https://gitlab.haskell.org/ghc/ghc/-/tree/master/utils/dump-decls?ref_type=heads |
I will add that we need to decide what to do now, too, for I opened a ticked specific for |
For |
I mentioned in #10161 that I believe this means we rushed 3.12.0.0 out too soon. I believe this because of all the stuff, including these two PRs, that we squeezed into 3.12.1.0 instead. |
You can use https://github.com/phadej/cabal-extras/tree/master/cabal-diff. |
It's imperative that a version of |
Thank you for the explanation of your reasoning. However, note that when the decision to release 3.12.0.0 was made at a Thursday meeting and process of the release was started by cutting the 3.12 branch, there was, by definition, zero pending backports (we cut release branches from current master, not from any older, tested version). We were 100% ready in terms of backports when we started the 3.12.0.0 release tasks. But, definitely, let's do a post-mortem at some later point and let's use the time to refine our inklings into well-thought arguments and recommendations. |
@Bodigrim, thank you for all your input, it's very helpful.
Sadly, the reasoning behind not releasing the tool at that time had a different ground: we were short-handed at that moment and no one had cycles to put the effort into it. At least, that's my recollection, and others should feel free to correct me if I'm wrong. |
The lesson I learned from maintaining other boot libraries is to keep |
I will definitely take this advice for Haddock as well, thank you. :) |
@Bodigrim says "You can use https://github.com/phadej/cabal-extras/tree/master/cabal-diff." in #10160 (comment), so maybe we can have a look and ask for any extra hints. Edit: oh, hah, it's just a few comments above. BTW, another sage advice: "Check that there are |
Describe the bug
As a dev team, we are failing in spotting PVP breakage.
To Reproduce
Last
Cabal
release (3.12.1.0
) was a minor one (that is from from3.12.0.0
to3.12.1.0
).This means no PVP breaking changes should have been introduced.
Alas, at least two of those breaking changes are present in the release, see PRs #9766 and #9878. Both those PRs introduce a new constructor, hence the backport actually changed the API for
Cabal
.Expected behavior
We don't let breaking changes slip in minor cabal releases, be it with the help of a checklist or automated testing or anything else (suggestion welcome).
The text was updated successfully, but these errors were encountered: