Add Readme section to get_module_details output#306
Open
huynhsontung wants to merge 3 commits intohashicorp:mainfrom
Open
Add Readme section to get_module_details output#306huynhsontung wants to merge 3 commits intohashicorp:mainfrom
get_module_details output#306huynhsontung wants to merge 3 commits intohashicorp:mainfrom
Conversation
…sections Agent-Logs-Url: https://github.com/huynhsontung/terraform-mcp-server/sessions/15dc6c8a-0ca1-4827-b7f6-550a6b2e082d Co-authored-by: huynhsontung <31434093+huynhsontung@users.noreply.github.com>
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes 1 out of 2 committers have signed the CLA.
Have you signed the CLA already but the status is still pending? Recheck it. |
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.
get_module_detailswas not surfacing the root README from the registry API response. This adds the README to the output, filtered to remove sections (inputs, outputs, dependencies, resources) already represented as structured data — consistent with howget_private_module_detailshandles it.Changes
pkg/utils/utils.go— PromotedremoveReadmeSectionsfromtfepackage to shared, exportedRemoveReadmeSectionsutility to avoid duplicationpkg/tools/registry/get_module_details.go— Added### Readmesection at the end ofunmarshalTerraformModule, populated fromRoot.Readmeand cleaned viautils.RemoveReadmeSections; skipped when emptypkg/tools/tfe/get_private_module_details.go— Replaced localremoveReadmeSectionscall withutils.RemoveReadmeSections; removed now-unusedregexpimportTestRemoveReadmeSectionsinutils_test.go; addedTestUnmarshalModuleSingular_WithReadmeandTestUnmarshalModuleSingular_EmptyReadmeinget_module_details_test.goPCI review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.