Skip to content

Add source_code, homepage and changelog uris to gemspec metadata #1017

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 5, 2023
Merged

Add source_code, homepage and changelog uris to gemspec metadata #1017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions rdoc.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
s.homepage = "https://ruby.github.io/rdoc"
s.licenses = ["Ruby"]

s.metadata["homepage_uri"] = s.homepage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn’t rubygems.org fallback to #homepage?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think a lot of tools favour homepage over metadata, but I thought it wouldn't harm to add it. Do you prefer not adding homepage_uri?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just I was curious a little.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadata.homepage_uri value is going to be copied from homepage when metadata.homepage_uri was not given. So, it'd be better to keep metadata.homepage_uri empty if there's no special reason to specify both. We don't need to repeat what RubyGems internally does.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see: https://github.com/rubygems/rubygems/blob/57b6c04dc2aac0607d52468918b45babadd0e10d/lib/rubygems/specification_policy.rb#L411-L421

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amatsuda That method looks like just validating Specification#homepage, but nothing about metadata["homepage_uri"], no?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed! My bad, please forget about my comment above...!

s.metadata["source_code_uri"] = "https://github.com/ruby/rdoc"
s.metadata["changelog_uri"] = "#{s.metadata["source_code_uri"]}/releases"

s.bindir = "exe"
s.executables = ["rdoc", "ri"]
s.require_paths = ["lib"]
Expand Down