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/rails-html-sanitizer and be available via the
rubygems API after the next release.
  • Loading branch information
orien committed Oct 5, 2019
1 parent 43a87f5 commit 845da04
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions rails-html-sanitizer.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ Gem::Specification.new do |spec|
spec.homepage = "https://github.com/rails/rails-html-sanitizer"
spec.license = "MIT"

spec.metadata = {
"bug_tracker_uri" => "https://github.com/rails/rails-html-sanitizer/issues",
"changelog_uri" => "https://github.com/rails/rails-html-sanitizer/blob/v#{spec.version}/CHANGELOG.md",
"documentation_uri" => "https://www.rubydoc.info/gems/rails-html-sanitizer/#{spec.version}",
"source_code_uri" => "https://github.com/rails/rails-html-sanitizer/tree/v#{spec.version}",
}

spec.files = Dir["lib/**/*", "README.md", "MIT-LICENSE", "CHANGELOG.md"]
spec.test_files = Dir["test/**/*"]
spec.require_paths = ["lib"]
Expand Down

0 comments on commit 845da04

Please sign in to comment.