[Ruby] Add support for populating a gem metadata#16872
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Oct 23, 2023
Merged
[Ruby] Add support for populating a gem metadata#16872wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
b0a4c3a to
5459bee
Compare
This defaults to an empty hash, but can be overridden with any custom object by the callers via the `gemMetadata` property.
The gemspecs files will now include a metadata field
5459bee to
f7b6008
Compare
Member
|
LGTM. Thanks for the PR. |
This file contains hidden or 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
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.
Currently there is no easy way to specify a gem's metadata. Metadata is often used to reference related links for a given gem, but is otherwise a generic key/value dictionary that can be looked up by consumers of the gem. For example, can be used to specify if multi factor authentication is required when publishing on rubygems (rails example).
This pull request adds support for populating a gem's metadata by introducing an additional property (
gemMetadata). This can be any arbitrary object, even though it should follow the rubygems specs.I briefly considered using a list of entries instead where each entry would be a key/value pair in the hash. However the somewhat arbitrary nature of values (urls, strings, bools, ...) make the implementation quite complex with very little return of investment, given that complex cases with this PR can be easily worked around by just using a multiline yaml in the config file. E.g. something like this produces the correct result:
Fixes #16870
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)cc @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)