Display of CHANGELOG file per version

Kieran P's Avatar

Kieran P

23 Jan, 2010 07:01 PM

Each version usually contains some type of change log file. While Gemcutter couldn't support all the types of formats people use, it could be dedicated to use a very basic way of store this information, to make the gem versions pages more informative. As an example, you could support a yml file, that has the following:

---
1.0pre:
  - Refactoring
  - Speed enhancements
0.9:
  - Fixed issue

Obviously the implementation can change, but the basic idea is to get this change log info on the page per version.

  1. Support Staff 1 Posted by Eric Hodel on 23 Jan, 2010 09:03 PM

    Eric Hodel's Avatar

    My experience with YAML in ruby and RubyGems has shown me that it is worst possible format you can use to store data. Furthermore, having a YAML file for this data causes it to be entered twice, once for human consumption and once for machine consumption.

    Hoe's History.txt file is superior to YAML, IMO

  2. 2 Posted by Kieran P on 23 Jan, 2010 11:17 PM

    Kieran P's Avatar

    Right. Like I said, the implementation can change, but the idea is to have a format that Gemcutter can easily parse, which gem authors stick to in order to get this information displayed. It would be a really nice addition to the gem version pages.

  3. Support Staff 3 Posted by Nick Quaranto on 23 Jan, 2010 11:20 PM

    Nick Quaranto's Avatar

    It would be nice to piggyback off an accepted standard, such as:

    http://www.gnu.org/software/emacs/manual/html_node/emacs/Format-of-...

    In any case, we don't extract any information from the built gems as is right now. Both this and readmes would be the first, and should be approached similarly. It would be nice to have full text search on each. All of this has been in the pipeline for a while, just no one's picked up lead on it. I'd be willing to help in any way, but stability of the service has been my #1 priority as of late.

  4. 4 Posted by Evan on 23 Jan, 2010 11:28 PM

    Evan's Avatar

    You are welcome to grab the changelog patterns from Echoe: http://github.com/fauna/echoe/blob/master/lib/echoe.rb#L171 . Hoe/Jeweler probably have a similar facility.

    It doesn't have to be a machine format; gem authors can choose to conform if they want.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

30 Oct, 2014 04:34 PM
30 Oct, 2014 02:46 PM
28 Oct, 2014 09:51 AM
23 Oct, 2014 05:37 PM
21 Oct, 2014 10:47 AM