search

lpsmith / postgresql-simple

Mid-level client library for accessing PostgreSQL from Haskell
Other
206 stars 71 forks source link

CHANGES is not in dist tarball #183

Closed charles-cooper closed 8 years ago

charles-cooper commented 8 years ago

See https://hackage.haskell.org/package/postgresql-simple -- no changelog! I think the appropriate thing to do is add CHANGES to the extra-source-files section. Having the changelog in the dist tarball is helpful for example when reviewing stackage diffs: https://www.stackage.org/diff/lts-5.14/lts-5.15.

lpsmith commented 8 years ago

Not including the changelog is not an accident, but I'm open to reversing that decision. Leaving it out does make the download a wee bit smaller, and I kinda like the ability to tweak the changelog without uploading a new version.

lpsmith commented 8 years ago

Oh, stack doesn't include a link to the repo listed in the .cabal file, unlike hackage, so the changelog isn't as "close". Ugh.

lpsmith commented 8 years ago

Yes, now that I've been experimenting with Stack a little bit, I can see that leaving the changelog out entirely is less than desirable.

What if I included a CHANGELOG.md that had a link to github? Or, perhaps, a truncated changelog with only a few of the most recent releases, and a link to the full changelog on github? I wonder if cabal sdist has a hook for generating that sort of file...

charles-cooper commented 8 years ago

Thanks!