Provide a 'Changelog' link on rubygems.org/gems/bigdecimal #281
Conversation
By providing a 'changelog_uri' in the metadata of the gemspec a 'Changelog' link will be shown on https://rubygems.org/gems/bigdecimal which makes it quick and easy for someone to check on the changes introduced with a new version. Details of this functionality can be found on https://guides.rubygems.org/specification-reference/
| @@ -51,4 51,6 @@ Gem::Specification.new do |s| | |||
| end | |||
|
|
|||
| s.required_ruby_version = Gem::Requirement.new(">= 2.5.0") | |||
|
|
|||
| s.metadata["changelog_uri"] = s.homepage "/blob/master/CHANGES.md" | |||
There was a problem hiding this comment.
Tip
Idea: We can use the s.version number rather than the latest changes in the default branch here.
| s.metadata["changelog_uri"] = s.homepage "/blob/master/CHANGES.md" | |
| s.metadata["changelog_uri"] = "#{s.homepage}/blob/v#{s.version}/CHANGES.md" |
- An upside is stability, we show what was there at the time.
- A downside is stability, we show what was there at the the time: https://github.com/ruby/bigdecimal/blob/v3.1.4/CHANGES.md does not include the 3.1.4 changes. The text for the changes in that version were written and released later.
There was a problem hiding this comment.
@olleolleolle thank you for this suggestion. My feeling is that the link should take the viewer to the latest change log (CHANGES.md). When I am looking to assess the impact of a new version of a gem to our application I want to quickly see what has changed, and ideally have anything impactful highlighted. At times I will be looking at multiple version changes between the one currently in use gem and the latest, so having everything clear to see on one page works best for me.
There was a problem hiding this comment.
@olleolleolle Referring to the master branch is good because the latest CHANGES.md should include all the changes of the released versions. So, I'll merge this as is.
By providing a 'changelog_uri' in the metadata of the gemspec a 'Changelog' link will be shown on https://rubygems.org/gems/bigdecimal which makes it quick and easy for someone to check on the changes introduced with a new version.
Details of this functionality can be found on https://guides.rubygems.org/specification-reference/