Add homepage & metadata to betterlint.gemspec #43
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
Metadata will help people on RubyGems.org, or other library indexers, to find the source code, issue tracker, CHANGELOG, etc
pboling
commented
May 2, 2024
|
|
||
| s.homepage = "https://github.com/Betterment/#{s.name}" | ||
| s.metadata["homepage_uri"] = s.homepage | ||
| s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}" |
There was a problem hiding this comment.
Dynamically links directly to the tag of the release for the version in the version.rb, which for any release is the source of that specific release!
Set once and forget it!
| s.homepage = "https://github.com/Betterment/#{s.name}" | ||
| s.metadata["homepage_uri"] = s.homepage | ||
| s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}" | ||
| s.metadata["changelog_uri"] = "#{s.homepage}/blob/v#{s.version}/CHANGELOG.md" |
There was a problem hiding this comment.
This will result in a link to the CHANGELOG.md directly from Rubygems.org.
| s.metadata["homepage_uri"] = s.homepage | ||
| s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}" | ||
| s.metadata["changelog_uri"] = "#{s.homepage}/blob/v#{s.version}/CHANGELOG.md" | ||
| s.metadata["bug_tracker_uri"] = "#{s.homepage}/issues" |
There was a problem hiding this comment.
Will also be linked from rubygems.org!
| s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}" | ||
| s.metadata["changelog_uri"] = "#{s.homepage}/blob/v#{s.version}/CHANGELOG.md" | ||
| s.metadata["bug_tracker_uri"] = "#{s.homepage}/issues" | ||
| s.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/#{s.name}/#{s.version}" |
There was a problem hiding this comment.
Dynamically link to the version of the documentation that is specific to a given release!
smudge
approved these changes
Jun 4, 2024
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.
Metadata will help people on RubyGems.org, or other library indexers, to find the source code, issue tracker, CHANGELOG, etc