Simplify Bicep JSONRPC doc generation contract - #20215
Open
Anthony Martin (anthony-c-martin) wants to merge 2 commits into
Open
Simplify Bicep JSONRPC doc generation contract#20215Anthony Martin (anthony-c-martin) wants to merge 2 commits into
Anthony Martin (anthony-c-martin) wants to merge 2 commits into
Conversation
Replaces bicep/generateDocs and bicep/outputDocs with bicep/renderDocs and bicep/getDocsModel, and marks both as experimental. generateDocs was the only RPC method that wrote to disk. bicep/compile is the RPC counterpart of bicep build and returns Contents rather than writing main.json; renderDocs now follows that convention. The CLI merged docs output into docs generate --stdout, so splitting two methods by output destination no longer matched any command. getDocsModel returns the typed documentation model, which previously required rendering Markdown and parsing it back. getDocsModel resolves options from bicepconfig.json so usage-example discovery and configured custom values match what renderDocs and the CLI produce. Also corrects the client version gate from 0.46.0 to 0.47.0. Both 0.46.0 and 0.46.1 shipped before the docs feature merged, so the old gate let clients pass the check and then fail with method not found. Fixes BaselineHelper.GetRepoRoot to accept a .git file as a repo-root marker so baseline tests run from a git worktree, where .git is a file rather than a directory. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
|
Test this change out locally with the following install scripts (Action run 32444580214) VSCode
Azure CLI
|
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
2 participants
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.
Microsoft Reviewers: Open in CodeFlow