gem_updater

gem_updater copied to clipboard

I've come across a few different changelog naming conventions that are currently not handled:

• XXX_CHANGELOG.md: see Sass (which is also nested in a documentation folder)
• NEWS.md: for instance, shoulda-matchers, factory_girl, factory_girl_rails
• GitHub releases: used by a growing number of maintainers. For instance, the folks behind Guard and its related gems, select2, sass-rails

If you'd like, I can keep a tally of the relative popularity of these alternate naming conventions (and others that I come across), and then perhaps if they are widely used, open a pull request to handle them?

Let me know what you think! Thanks!

Hi you're right, there is a bunch of other locations for changelogs that should be supported.

• news.md is just a matter of adding it here.
• XXX_CHANGELOG.md at first glance I would said this means checking not the whole filename but only that it contains the desired string. But since sass nests it in another directory, I think this is rare enough to be considered as an edge case. Well that should still be supported, so the best option would be to maintain a list of gems known for not having a standard changelog location and hardcode the correct path. Since this list may tend to grow, I would suggest a dedicated yml file that lists gem and corresponding uri. This way SourcePageParser could at first look in this file for an explicit location before doing it the traditional way.
• GitHub releases YES! It should, definitely, just as it should support gems hosted on bitbucket. I did not have time for it lately, but this is clearly an enhancement to be made.

Thank you for your explicit report, and do not hesitate to open a pull request if you have a way to handle one of those.

Awesome, I'll open a pull request for news.md. And that makes sense about the sass changelog. Sounds good about Github releases - if I get some free time, I'll look into it. Thanks!