-
Notifications
You must be signed in to change notification settings - Fork 695
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
Create changelogs for 3.14.1.0 #10576
Conversation
7820f9d
to
8108032
Compare
8108032
to
3e9352b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was always fuzzy on Cabal changelogs between x.y.0.0 and x.y.1.0. I think @Mikolaj mentioned at some point that it may be a good idea to include one into another literally because x.y.0.0 is released without the tool, and hence is much less visible.
But maybe it's too cumbersome, and I see that 3.12 didn't do that.
That's why I suggest to have release notes that are not the bare changelog: to be able to bring visibility to things that may otherwise be missed when people only read changelogs. |
Co-authored-by: ffaf1 <[email protected]>
Co-authored-by: ffaf1 <[email protected]>
I've had a look at the changelog and, unrelated, noticed that https://hackage.haskell.org/package/Cabal-3.14.0.0/changelog contains a duplicated entry for 3.12.0.0 and https://hackage.haskell.org/package/cabal-install-3.12.1.0/changelog is messed up as well. Could we fix both on 3.14 branch and on master? I can see the same problem in the repo at https://github.com/haskell/cabal/blob/master/Cabal/ChangeLog.md, while https://github.com/haskell/cabal/blob/master/cabal-install/changelog seems to be fixed. I haven't checked branch 3.14. I suppose this was at some point fixed on release branches and not forward-ported to master? Related to your point: yes, I proposed to include both .0 and .1 changelogs in the .1 file, with proper headers and when that did not find support I begged to at least link to the older changelog, to make sure people understand there was a .0 release without the tool. We didn't do that. I think we should be courageous adding even longer preambles to changelogs. That's one of the advantage of having many changelog files instead of one big file --- with the big file, interspersing actual changelogs with rambling prose would be out of place, while here it's proper IMHO, since these are mixed changelog/release notes files. In the same way, repetition is fine, but I don't insist, a link would be enough. |
Unrelated, would be great to convert the cabal-install changelog file (e.g. https://hackage.haskell.org/package/cabal-install-3.12.1.0/changelog) to proper markdown so that it’s rendered in a civil way (like, say, Cabal’s changelog, e.g. https://hackage.haskell.org/package/Cabal-3.14.0.0/changelog). |
Having release notes is a fine idea, my issue is that it’s not something Hackage understands (unlike changelogs, which have a special place in the UI). So I’m unsure how you propose to distribute these “release notes”. |
@ulysses4ever https://blog.haskell.org as I said during one of our calls. |
Mm, that could be fun, yes |
This PR creates the appropriate changelogs for the 3.14.1.0 release.