[KNOW-175]: migrate catalog-info.yaml metadata into gemspec for Developer Portal ingestion#241
Draft
modethirteen wants to merge 1 commit into
Draft
[KNOW-175]: migrate catalog-info.yaml metadata into gemspec for Developer Portal ingestion#241modethirteen wants to merge 1 commit into
modethirteen wants to merge 1 commit into
Conversation
modethirteen
force-pushed
the
devProdUseGemspecCatalogIngestor
branch
from
f51911b to
27868d5
Compare
…talog ingestor Remove authored catalog-info.yaml and express the mappable metadata via the gemspec's documentation_uri and developer.appf.io/* keys so the Developer Portal gemspec catalog ingestor generates the component. Gems (1): ae_page_objects.gemspec
modethirteen
force-pushed
the
devProdUseGemspecCatalogIngestor
branch
from
27868d5 to
1c867a6
Compare
modethirteen
changed the title
|
Jira Issue: https://appfolio.atlassian.net/browse/KNOW-175 |
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
1 participant
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.
Summary
The Developer Portal now automatically discovers your gem's
.gemspecand lists it in the catalog — you no longer need a hand-writtencatalog-info.yaml. This PR removes the authoredcatalog-info.yamlfor this gem and moves the still-relevant details into the.gemspec, so the portal keeps the catalog entry up to date from the gem itself.What changed
catalog-info.yamlsummaryanddescriptionWhy the gem summary and description changed
The removed
catalog-info.yamlhad a description that was more detailed than the gemspec's summary, so we included both in the gemspec: a shortsummaryand the fullerdescription.Optional gemspec metadata the Developer Portal understands
The portal reads the basics (name, description, version, docs link) straight from the gem. If you want to fine‑tune how your gem shows up, you can add any of these optional keys to the
metadatahash in your.gemspec. Everything below is opt‑in; leave a key out and the portal just makes a sensible default guess.developer.appf.io/ownerdeveloper.appf.io/systemdeveloper.appf.io/componentdeveloper.appf.io/depends_ondeveloper.appf.io/consumes_apisdeveloper.appf.io/lifecycledeprecatedto flag the gem as deprecated.documentation_uriExample:
🤖 Generated with Claude Code