Specify metadata to provide richer information on rubygems.org #532
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
st0012
commented
Mar 1, 2023
| @@ -16,6 +16,11 @@ Gem::Specification.new do |spec| | |||
| spec.homepage = "https://github.com/ruby/irb" | |||
| spec.licenses = ["Ruby", "BSD-2-Clause"] | |||
|
|
|||
| spec.metadata["homepage_uri"] = spec.homepage | |||
| spec.metadata["source_code_uri"] = spec.homepage | |||
| spec.metadata["documentation_uri"] = spec.homepage | |||
There was a problem hiding this comment.
I specifically override the documentation's destination because the readme here has the most up-to-date info. We can modify it later when we improve the documentation on docs.ruby-lang.org.
st0012
commented
Mar 1, 2023
| spec.metadata["homepage_uri"] = spec.homepage | ||
| spec.metadata["source_code_uri"] = spec.homepage | ||
| spec.metadata["documentation_uri"] = spec.homepage | ||
| spec.metadata["changelog_uri"] = "#{spec.homepage}/releases" |
There was a problem hiding this comment.
I figure we don't want to maintain a CHANGELOG file yet so let's just use the release generated by GH for now, which will be enhanced after #531.
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.
Since we're encouraging users to use
irbas a gem, I feel it'd be worth enriching its rubygems.org page a bit and we can customise the sidebar items with themetadataattribute.