Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Add changelog feature to hackagedb #292

Closed
bos opened this Issue May 24, 2012 · 9 comments

Comments

Projects
None yet
2 participants
Contributor

bos commented May 24, 2012

(Imported from Trac #299, reported by guest on 2008-06-19)

It would be great if releases on hackagedb were required (or even permitted) to
include short descriptions of the changes made since the last release. Currently
there is no easy way to get this information for most packages, since many packages
have no home page other than their hackagedb page.

Contributor

bos commented May 24, 2012

(Imported comment by @dcoutts on 2008-06-19)

See also #244

Contributor

bos commented May 24, 2012

(Imported comment by @dcoutts on 2008-10-29)

Specifying a changelog in a .cabal file would be easy. The issue is what hackage should display.

One suggestion is to specify a changelog file and diff it from one release to the next and display only the diff. It could perhaps be parsed and displayed as haddock markup. This could go in the rss feed and on the package version page.

Contributor

bos commented May 24, 2012

(Imported comment by @dcoutts on 2009-03-03)

See also a couple suggestions in reply to this email:

http://haskell.org/pipermail/haskell-cafe/2009-March/057271.html

Contributor

bos commented May 24, 2012

(Imported comment by wolverian on 2009-03-09)

For what it's worth, CPAN doesn't (as for now) mandate a specific Changelog format, and the interfaces do not display diffs, but simply link to the Changes/CHANGELOG/etc file[1]. Going down that route would of course end up in difficulties if we wanted to mandate a specific format in the future, unless we use versioning bits.

The point is that this is much easier to do than figuring out a real design for the Changelog format.

[1]: E.g. The overview page and the Changes file linked to from there.

Contributor

bos commented May 24, 2012

(Imported comment by @vvv on 2009-03-13)

Debian policy requires
changelogs of standard format.

Changelogs are updated with
debchange(1)
tool and can be parsed with
parsechangelog(1p).

See the
sample
changelog.

Contributor

bos commented May 24, 2012

(Imported comment by ross on 2009-12-16)

I think that a changelog format that parsed to [(Version, String)] would be sufficient, though the String might require (Haddock-style?) markup. The additional info in Debian or Gentoo changelogs is available via the version number.

Contributor

bos commented May 24, 2012

(Imported comment by dsfox on 2009-12-22)

Replying to ross:

I think that a changelog format that parsed to [(Version, String)] would be sufficient, though the String might require (Haddock-style?) markup. The additional info in Debian or Gentoo changelogs is available via the version number.

Surely we also need to know when the entry was made and who made it?

Contributor

bos commented May 24, 2012

(Imported comment by dsfox on 2011-08-18)

Replying to dsfox:

Replying to ross:
I think that a changelog format that parsed to [(Version, String)] would be sufficient, though the String might require (Haddock-style?) markup. The additional info in Debian or Gentoo changelogs is available via the version number.

Surely we also need to know when the entry was made and who made it?

That is to say, we're talking about changelogs created upstream from any debian or gentoo packaging logs. We need to record authoritative information before that happens.
Member

23Skidoo commented Apr 20, 2014

Really a hackage server issue, and a fixed one.

@23Skidoo 23Skidoo closed this Apr 20, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment