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 3.10.3.0 moved simpleProgram between nodules and, so, is *not* strictly a bug-fix release #9863

Closed
lyokha opened this issue Apr 3, 2024 · 4 comments · Fixed by #10264

Comments

@lyokha
Copy link
Collaborator

lyokha commented Apr 3, 2024

Describe the bug
This is not a bug but rather a short remark. The 3.10.3.0 release was announced as strictly a bug-fix release, but, comparing to 3.10.2.1, there are changes in the interface that may affect users.

I used simpleProgram in my custom code with

import Distribution.Simple.Program.Types

The simpleProgram was previously defined in that module, but in the new release it was moved directly into Distribution.Simple.Program. Therefore, the code failed to compile after the upgrade, so I had to replace all my granular imports with the single Distribution.Simple.Program.

Btw, I agree that Distribution.Simple.Program.Types is not a proper place for simpeProgram.

@geekosaur
Copy link
Collaborator

Arguably that calls for 3.10.3.1 to reexport it, since API changes like that seem wrong.

@lyokha
Copy link
Collaborator Author

lyokha commented Apr 4, 2024

Previously, it was reexported from Distribution.Simple.Program, those who used the short module directly (i believe this should be a usual case as it's more convenient) won't notice the change.

@lyokha
Copy link
Collaborator Author

lyokha commented Apr 4, 2024

In 3.10.3.0 simpleProgram was moved from Distribution.Simple.Program.Types to Distribution.Simple.Program.Find.

@gbaz
Copy link
Collaborator

gbaz commented Apr 4, 2024

indeed this was a pvp breaking change (#9544) and we shouldn't have let it into a minor release. i think the damage is done at this point, and wouldn't want to reintroduce the problematic module dependency that pr introduced in a further release -- however we should be more mindful in the future, perhaps with automated api-surface comparison tools.

mstksg pushed a commit to mstksg/hoppy that referenced this issue May 15, 2024
simpleProgram stopped being exported from Distribution.Simple.Program.Types.
It's still imported from Distribution.Simple.Program so let's refer to it there.

See: haskell/cabal#9863
See: haskell/cabal#9544
@mergify mergify bot closed this as completed in #10264 Sep 1, 2024
@ulysses4ever ulysses4ever changed the title Release 3.10.3.0 is *not* strictly a bug-fix release Release 3.10.3.0 moved simpleProgram between nodules and, so, is *not* strictly a bug-fix release Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants