Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add project metadata to the gemspec #1938

Merged
merged 1 commit into from Dec 1, 2019
Merged

Conversation

@orien
Copy link
Contributor

orien commented Dec 1, 2019

Add bug_tracker_uri, changelog_uri, documentation_uri, and source_code_uri to 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 gem and bundle command-line tools with the next release.

@grape-bot

This comment has been minimized.

Copy link

grape-bot commented Dec 1, 2019

1 Message
📖 We really appreciate pull requests that demonstrate issues, even without a fix. That said, the next step is to try and fix the failing tests!

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.
@dm1try dm1try merged commit fb11882 into ruby-grape:master Dec 1, 2019
1 check was pending
1 check was pending
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@orien orien deleted the orien:gem-metadata branch Dec 1, 2019
@dm1try

This comment has been minimized.

Copy link
Member

dm1try commented Dec 1, 2019

@orien thanks!

@@ -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',

This comment has been minimized.

Copy link
@dblock

dblock Dec 2, 2019

Member

Do these have to be strings? or bug_tracker_uri: 'http...' which would read a bit cleaner. I am totally nitpicking.

@orien

This comment has been minimized.

Copy link
Contributor Author

orien commented Dec 2, 2019

@dblock: Apparently they need to be strings:

All keys and values must 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
Projects
None yet
4 participants
You can’t perform that action at this time.