Skip to content

Commit

Permalink
Add project metadata to the gemspec
Browse files Browse the repository at this point in the history
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/jaro_winkler and be available via the rubygems
API after the next release.
  • Loading branch information
orien committed Oct 30, 2019
1 parent 50990da commit 6591989
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions jaro_winkler.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Gem::Specification.new do |spec|
UTF-8, EUC-JP, Big5, etc.'
spec.homepage = 'https://github.com/tonytonyjan/jaro_winkler'
spec.license = 'MIT'
spec.metadata = {
'bug_tracker_uri' => 'https://github.com/tonytonyjan/jaro_winkler/issues',
'changelog_uri' => "https://github.com/tonytonyjan/jaro_winkler/blob/v#{spec.version}/CHANGELOG.md",
'documentation_uri' => "https://www.rubydoc.info/gems/jaro_winkler/#{spec.version}",
'source_code_uri' => "https://github.com/tonytonyjan/jaro_winkler/tree/v#{spec.version}",
}
spec.files = Dir['lib/**/*.rb', 'ext/**/*.{h,c}', 'LICENSE.txt']
spec.add_development_dependency 'bundler', '~> 1.7'
spec.add_development_dependency 'rake', '~> 12.0'
Expand Down
6 changes: 6 additions & 0 deletions jaro_winkler.java.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ Gem::Specification.new do |spec|
UTF-8, EUC-JP, Big5, etc.'
spec.homepage = 'https://github.com/tonytonyjan/jaro_winkler'
spec.license = 'MIT'
spec.metadata = {
'bug_tracker_uri' => 'https://github.com/tonytonyjan/jaro_winkler/issues',
'changelog_uri' => "https://github.com/tonytonyjan/jaro_winkler/blob/v#{spec.version}/CHANGELOG.md",
'documentation_uri' => "https://www.rubydoc.info/gems/jaro_winkler/#{spec.version}",
'source_code_uri' => "https://github.com/tonytonyjan/jaro_winkler/tree/v#{spec.version}",
}
spec.files = Dir['lib/**/*.rb', 'LICENSE.txt']
spec.add_development_dependency 'bundler', '~> 1.7'
spec.add_development_dependency 'rake', '~> 12.0'
Expand Down

0 comments on commit 6591989

Please sign in to comment.