Add project metadata to the gemspec #1938
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generated by 🚫 danger |
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.
|
@orien thanks! |
dblock
reviewed
Dec 2, 2019
| @@ -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', | |||
There was a problem hiding this comment.
Do these have to be strings? or bug_tracker_uri: 'http...' which would read a bit cleaner. I am totally nitpicking.
|
@dblock: Apparently they need to be strings:
https://guides.rubygems.org/specification-reference/#metadata |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
bug_tracker_uri,changelog_uri,documentation_uri, andsource_code_urito the gemspec metadata.These project metadata will facilitate easy access to project information. The URI will be available on the Rubygems project page, via the rubygems API, and the
gemandbundlecommand-line tools with the next release.