feat: Add .fern.metadata.json to generated SDK outputs #9887
+103
−76
Conversation
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
This commit implements a feature to include configuration metadata in all generated SDK outputs. The metadata file (.fern.metadata.json) is automatically created during the generation process and includes: - CLI version (from versions.yml) - Generator name and version - generators.yml configuration settings This addresses the internal ticket requesting better visibility into the configuration context used for SDK generation, making it easier to debug issues and understand which versions/configs were used. The metadata file is written to the output directory after the generator executes but before files are copied to their final destination, ensuring it's included in all generated SDK artifacts. Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
devin-ai-integration
bot
changed the title
… and remote generation Co-Authored-By: [email protected] <[email protected]>
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.
Description
Linear ticket: [internal] Add config artifacts to generated SDK outputs
Implements a feature to include configuration metadata in all generated SDK outputs. A
.fern.metadata.jsonfile is now automatically added to the root of generated SDK directories, containing CLI version, generator information, and configuration settings. This metadata will help with debugging and support by providing context about the generation environment.Session URL: https://app.devin.ai/sessions/91a220a4ee9f40e7a9b3a73c0685a542
Requested by: [email protected] (@jsklan)
Changes Made
.fern.metadata.jsongeneration to both local and remote SDK generation pipelineswriteFernMetadata()function inlocal-workspace-runner/src/runGenerator.tsfor local generationwriteFernMetadata()function inremote-workspace-runner/src/RemoteTaskHandler.tsfor remote generationjs-yamldependency to package.json but it's not used in final implementation - should be removedMetadata Schema
{ "cliVersion": "0.92.0", "generatorName": "fernapi/fern-typescript-sdk", "generatorVersion": "3.8.10", "generatorsYml": { "config": { /* generator-specific config */ } } }Testing
.fern.metadata.jsonfile is created in output directoryprocess.env.CLI_VERSION)Review Checklist
js-yamland@types/js-yamldependencies frompackages/cli/generation/local-generation/local-workspace-runner/package.jsonprocess.env.CLI_VERSIONis properly set in production CLI builds (not just "unknown").fern.metadata.jsonis an appropriate filename and location (root of output directory)path.join) and remote (uses@fern-api/fs-utilsjoin) - both work but differ in style