From da3300837c77d3d87d70e1c9868d141107873a7a Mon Sep 17 00:00:00 2001 From: Orien Madgwick <_@orien.io> Date: Mon, 2 Dec 2019 08:00:20 +1100 Subject: [PATCH] Add project metadata to the gemspec As per https://guides.rubygems.org/specification-reference/#metadata, add metadata to the gemspec file. This'll allow people to more easily access the source code, raise issues and read the changelog. These `bug_tracker_uri`, `changelog_uri`, `documentation_uri` and `source_code_uri` links will appear on the rubygems page at https://rubygems.org/gems/grape and be available via the rubygems API after the next release. --- CHANGELOG.md | 1 + grape.gemspec | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2246c3b0cf..fbd8fb5485 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ #### Features * Your contribution here. +* [#1938](https://github.com/ruby-grape/grape/pull/1938): Add project metadata to the gemspec - [@orien](https://github.com/orien). #### Fixes diff --git a/grape.gemspec b/grape.gemspec index c3b5dec306..1e5bb712d6 100644 --- a/grape.gemspec +++ b/grape.gemspec @@ -11,6 +11,12 @@ Gem::Specification.new do |s| s.summary = 'A simple Ruby framework for building REST-like APIs.' s.description = 'A Ruby framework for rapid API development with great conventions.' s.license = 'MIT' + s.metadata = { + 'bug_tracker_uri' => 'https://github.com/ruby-grape/grape/issues', + 'changelog_uri' => "https://github.com/ruby-grape/grape/blob/v#{s.version}/CHANGELOG.md", + 'documentation_uri' => "https://www.rubydoc.info/gems/grape/#{s.version}", + 'source_code_uri' => "https://github.com/ruby-grape/grape/tree/v#{s.version}" + } s.add_runtime_dependency 'activesupport' s.add_runtime_dependency 'builder'